From b2b5b904bcc1ab96d5efb992d5630505022d0ecb Mon Sep 17 00:00:00 2001 From: Jason Gerard DeRose Date: Tue, 7 Oct 2008 20:07:16 -0600 Subject: [PATCH] Made package-level docstrings more consistent so they read better in generated documentation --- ipa_server/__init__.py | 2 +- ipa_server/plugins/b_ldap.py | 2 +- ipa_webui/__init__.py | 2 +- ipa_webui/templates/__init__.py | 2 +- ipalib/__init__.py | 2 +- ipalib/plugins/b_kerberos.py | 2 +- ipalib/plugins/b_xmlrpc.py | 5 +++-- 7 files changed, 9 insertions(+), 8 deletions(-) diff --git a/ipa_server/__init__.py b/ipa_server/__init__.py index 550192bf0..b0be96bd2 100644 --- a/ipa_server/__init__.py +++ b/ipa_server/__init__.py @@ -18,5 +18,5 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -Backend plugins and XML-RPC. +Package containing server backend. """ diff --git a/ipa_server/plugins/b_ldap.py b/ipa_server/plugins/b_ldap.py index 675c64c29..a8463aa76 100644 --- a/ipa_server/plugins/b_ldap.py +++ b/ipa_server/plugins/b_ldap.py @@ -18,7 +18,7 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -LDAP backend plugin. +Backend plugin for LDAP. This wraps the python-ldap bindings. """ diff --git a/ipa_webui/__init__.py b/ipa_webui/__init__.py index d0b433012..408481a27 100644 --- a/ipa_webui/__init__.py +++ b/ipa_webui/__init__.py @@ -17,7 +17,7 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -IPA web-based user interface. +Package containing web-based UI components. """ import kid diff --git a/ipa_webui/templates/__init__.py b/ipa_webui/templates/__init__.py index 710dbb2e9..10d4cf8ca 100644 --- a/ipa_webui/templates/__init__.py +++ b/ipa_webui/templates/__init__.py @@ -17,5 +17,5 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -Kid templates. +Sub-package containing Kid templates. """ diff --git a/ipalib/__init__.py b/ipalib/__init__.py index 956e46101..46edb822e 100644 --- a/ipalib/__init__.py +++ b/ipalib/__init__.py @@ -18,7 +18,7 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -The IPA Library. +Package containing core library. To learn about the ``ipalib`` library, you should read the code in this order: diff --git a/ipalib/plugins/b_kerberos.py b/ipalib/plugins/b_kerberos.py index 4b3a9a5b2..cc8204976 100644 --- a/ipalib/plugins/b_kerberos.py +++ b/ipalib/plugins/b_kerberos.py @@ -18,7 +18,7 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -Kerberos backend. +Backend plugin for Kerberos. This wraps the python-kerberos and python-krbV bindings. """ diff --git a/ipalib/plugins/b_xmlrpc.py b/ipalib/plugins/b_xmlrpc.py index d7cbd8560..feb87556b 100644 --- a/ipalib/plugins/b_xmlrpc.py +++ b/ipalib/plugins/b_xmlrpc.py @@ -18,9 +18,10 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA """ -XML-RPC client plugin. +Backend plugin for XML-RPC client. -Lightwieght XML-RPC client using Python standard library xmlrpclib. +This provides a lightwieght XML-RPC client using Python standard library +``xmlrpclib`` module. """ import xmlrpclib