summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason Gerard DeRose <jderose@redhat.com>2008-10-07 20:07:16 -0600
committerJason Gerard DeRose <jderose@redhat.com>2008-10-07 20:07:16 -0600
commitb2b5b904bcc1ab96d5efb992d5630505022d0ecb (patch)
tree2816961aae1eff515884fe95c6ca3248df59ba5f
parentc747c12fb2249e987d327f764bf9f1ddb5e60ee6 (diff)
downloadfreeipa-b2b5b904bcc1ab96d5efb992d5630505022d0ecb.tar.gz
freeipa-b2b5b904bcc1ab96d5efb992d5630505022d0ecb.tar.xz
freeipa-b2b5b904bcc1ab96d5efb992d5630505022d0ecb.zip
Made package-level docstrings more consistent so they read better in generated documentation
-rw-r--r--ipa_server/__init__.py2
-rw-r--r--ipa_server/plugins/b_ldap.py2
-rw-r--r--ipa_webui/__init__.py2
-rw-r--r--ipa_webui/templates/__init__.py2
-rw-r--r--ipalib/__init__.py2
-rw-r--r--ipalib/plugins/b_kerberos.py2
-rw-r--r--ipalib/plugins/b_xmlrpc.py5
7 files changed, 9 insertions, 8 deletions
diff --git a/ipa_server/__init__.py b/ipa_server/__init__.py
index 550192bf..b0be96bd 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 675c64c2..a8463aa7 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 d0b43301..408481a2 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 710dbb2e..10d4cf8c 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 956e4610..46edb822 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 4b3a9a5b..cc820497 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 d7cbd856..feb87556 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