163: Docstring improvement for ipalib/__init__.py and plugable.py

This commit is contained in:
Jason Gerard DeRose 2008-08-14 19:36:54 +00:00
parent f423f2c9f0
commit 43c04f1cd3
2 changed files with 6 additions and 4 deletions

View File

@ -20,11 +20,13 @@
"""
The IPA Library.
To learn about the library, you should probably read the code in this order:
To learn about the ``ipalib`` library, you should read the code in this order:
1. Start with the `ipalib.plugable` module
1. Learn about the plugin framework in `ipalib.plugable`
2. Then read the `ipalib.public` module
2. Learn about the public api in `ipalib.public`
3. Look at some example plugins in `ipalib.plugins.example`
Some of the plugin architecture was inspired by ``bzr``, so you might also
read http://bazaar-vcs.org/WritingPlugins

View File

@ -18,7 +18,7 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
Generic plugin framework.
Implementation of the plugin framework.
The classes in this module make heavy use of Python container emulation. If
you are unfamiliar with this Python feature, see