diff options
author | Jason Gerard DeRose <jderose@redhat.com> | 2008-09-04 09:22:18 +0000 |
---|---|---|
committer | Jason Gerard DeRose <jderose@redhat.com> | 2008-09-04 09:22:18 +0000 |
commit | 553b0c596d9dc1a955aece1fab28bd0cf3c81119 (patch) | |
tree | e7235268ed2333c46f52381a9cb3875b5c902fcb /ipalib/plugins | |
parent | 6b9ba734e119cbdc92ebc0a1b28d75b405d46bb0 (diff) | |
download | freeipa-553b0c596d9dc1a955aece1fab28bd0cf3c81119.tar.gz freeipa-553b0c596d9dc1a955aece1fab28bd0cf3c81119.tar.xz freeipa-553b0c596d9dc1a955aece1fab28bd0cf3c81119.zip |
264: Cleaned up docstrings on all example plugins
Diffstat (limited to 'ipalib/plugins')
-rw-r--r-- | ipalib/plugins/example.py | 22 | ||||
-rw-r--r-- | ipalib/plugins/override.py | 5 |
2 files changed, 14 insertions, 13 deletions
diff --git a/ipalib/plugins/example.py b/ipalib/plugins/example.py index ab752976..4c62a5de 100644 --- a/ipalib/plugins/example.py +++ b/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) diff --git a/ipalib/plugins/override.py b/ipalib/plugins/override.py index bc5666c2..1255eae7 100644 --- a/ipalib/plugins/override.py +++ b/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) |