diff options
| author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-09-06 13:55:50 -0400 |
|---|---|---|
| committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-09-06 13:55:50 -0400 |
| commit | 7d277c0d5fef3d0cdb9ca9b97cb2bca09f0f46c5 (patch) | |
| tree | 16cf42edd6ffcfd703ef3621369b6605a6998031 /src/lib/Bcfg2/Server/Plugin/__init__.py | |
| parent | d3aa773f9f42045a0922d6c194e01d029ee53a40 (diff) | |
| download | bcfg2-7d277c0d5fef3d0cdb9ca9b97cb2bca09f0f46c5.tar.gz bcfg2-7d277c0d5fef3d0cdb9ca9b97cb2bca09f0f46c5.tar.bz2 bcfg2-7d277c0d5fef3d0cdb9ca9b97cb2bca09f0f46c5.zip | |
Documented all plugin helper objects
Diffstat (limited to 'src/lib/Bcfg2/Server/Plugin/__init__.py')
| -rw-r--r-- | src/lib/Bcfg2/Server/Plugin/__init__.py | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/src/lib/Bcfg2/Server/Plugin/__init__.py b/src/lib/Bcfg2/Server/Plugin/__init__.py index 487a457e6..b76dbe7a0 100644 --- a/src/lib/Bcfg2/Server/Plugin/__init__.py +++ b/src/lib/Bcfg2/Server/Plugin/__init__.py @@ -1,5 +1,16 @@ -""" Bcfg2 server plugin base classes, interfaces, and helper -objects. """ +""" ``Bcfg2.Server.Plugin`` contains server plugin base classes, +interfaces, exceptions, and helper objects. This module is split into +a number of submodules to make it more manageable, but it imports all +symbols from the submodules, so with the exception of some +documentation it's not necessary to use the submodules. E.g., you can +(and should) do:: + + from Bcfg2.Server.Plugin import Plugin + +...rather than:: + + from Bcfg2.Server.Plugin.base import Plugin +""" import os import sys |