summaryrefslogtreecommitdiffstats
path: root/ipalib/__init__.py
diff options
context:
space:
mode:
authorJason Gerard DeRose <jderose@redhat.com>2008-08-14 09:01:02 +0000
committerJason Gerard DeRose <jderose@redhat.com>2008-08-14 09:01:02 +0000
commita3dc04ade4c8b640a881519144f009b70c6e4cfd (patch)
tree784866653de95cb28d295dc7e039bc53f392750e /ipalib/__init__.py
parentf0dfb9f873ccafcc77b34e36f03723d73f9c5e0c (diff)
downloadfreeipa-a3dc04ade4c8b640a881519144f009b70c6e4cfd.tar.gz
freeipa-a3dc04ade4c8b640a881519144f009b70c6e4cfd.tar.xz
freeipa-a3dc04ade4c8b640a881519144f009b70c6e4cfd.zip
157: More docstring cleanup; fixed remaining epydoc warnings
Diffstat (limited to 'ipalib/__init__.py')
-rw-r--r--ipalib/__init__.py11
1 files changed, 10 insertions, 1 deletions
diff --git a/ipalib/__init__.py b/ipalib/__init__.py
index ddce3ac92..309bd2e20 100644
--- a/ipalib/__init__.py
+++ b/ipalib/__init__.py
@@ -18,5 +18,14 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
-IPA library.
+The IPA Library.
+
+To learn about the library, you should probably read the code in this order:
+
+ 1. Start with the `ipalib.plugable` module
+
+ 2. Then read the `ipalib.public` module
+
+Some of the plugin architecture was inspired by ``bzr``, so you might also
+read http://bazaar-vcs.org/WritingPlugins
"""