264: Cleaned up docstrings on all example plugins

ipalib/cli.py

@@ -47,7 +47,7 @@ def from_cli(cli_name):
 
 
 class help(public.Application):
-    'Display help on command.'
+    'Display help on a command.'
     def __call__(self, key):
         key = str(key)
         if key not in self.application:
@@ -59,7 +59,7 @@ class help(public.Application):
 
 
 class console(public.Application):
-    'Start the IPA Python console.'
+    'Start the IPA interactive Python console.'
 
     def __call__(self):
         code.interact(

ipalib/plugins/example.py

@@ -28,11 +28,11 @@ from ipalib import api
 
 # Hypothetical functional commands (not associated with any object):
 class krbtest(public.Command):
-    'Test your Kerberos ticket'
+    'Test your Kerberos ticket.'
 api.register(krbtest)
 
 class discover(public.Command):
-    'Discover IPA servers on network'
+    'Discover IPA servers on network.'
 api.register(discover)
 
 
@@ -50,7 +50,7 @@ class user_mod(public.Method):
 api.register(user_mod)
 
 class user_find(public.Method):
-    'Search for existing users.'
+    'Search the users.'
 api.register(user_find)
 
 
@@ -86,37 +86,37 @@ api.register(user_initials)
 
 # Register some methods for the 'group' object:
 class group_add(public.Method):
-    'Add new group'
+    'Add a new group.'
 api.register(group_add)
 
 class group_del(public.Method):
-    'Delete existing group'
+    'Delete an existing group.'
 api.register(group_del)
 
 class group_mod(public.Method):
-    'Edit existing group'
+    'Edit an existing group.'
 api.register(group_mod)
 
 class group_find(public.Method):
-    'Search for groups'
+    'Search the groups.'
 api.register(group_find)
 
 
 # Register some methods for the 'service' object
 class service_add(public.Method):
-    'Add new service'
+    'Add a new service.'
 api.register(service_add)
 
 class service_del(public.Method):
-    'Delete existing service'
+    'Delete an existing service.'
 api.register(service_del)
 
 class service_mod(public.Method):
-    'Edit existing service'
+    'Edit an existing service.'
 api.register(service_mod)
 
 class service_find(public.Method):
-    'Search for services'
+    'Search the services.'
 api.register(service_find)
 
 

ipalib/plugins/override.py

@@ -28,6 +28,7 @@ from ipalib import public
 from ipalib import api
 
 if 'user_mod' in api.register.Method:
-    class user_mod(api.register.Method.user_mod):
-        '(override) Edit existing user'
+    base = api.register.Method.user_mod
+    class user_mod(base):
+        'Example override, see ipalib/plugins/override.py'
     api.register(user_mod, override=True)