summaryrefslogtreecommitdiffstats
path: root/ipalib/__init__.py
diff options
context:
space:
mode:
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 ddce3ac9..309bd2e2 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
"""