diff options
| author | Jason Gerard DeRose <jderose@redhat.com> | 2008-08-14 19:36:54 +0000 |
|---|---|---|
| committer | Jason Gerard DeRose <jderose@redhat.com> | 2008-08-14 19:36:54 +0000 |
| commit | 43c04f1cd356a46aab6720c64e8d15900b46bfdf (patch) | |
| tree | c9dff80d191a0f528963fb1228f0e33bf421b38a /ipalib/__init__.py | |
| parent | f423f2c9f0634d3b123eaaae8b13afd83cc0cf94 (diff) | |
| download | freeipa-43c04f1cd356a46aab6720c64e8d15900b46bfdf.tar.gz freeipa-43c04f1cd356a46aab6720c64e8d15900b46bfdf.tar.xz freeipa-43c04f1cd356a46aab6720c64e8d15900b46bfdf.zip | |
163: Docstring improvement for ipalib/__init__.py and plugable.py
Diffstat (limited to 'ipalib/__init__.py')
| -rw-r--r-- | ipalib/__init__.py | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/ipalib/__init__.py b/ipalib/__init__.py index 309bd2e20..84b529e17 100644 --- a/ipalib/__init__.py +++ b/ipalib/__init__.py @@ -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 |