IntenseWebs/freeipa
3
0
Fork 0
mirror of https://salsa.debian.org/freeipa-team/freeipa.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

8
ipalib/__init__.py
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