summaryrefslogtreecommitdiffstats
path: root/ipalib/plugable.py
diff options
context:
space:
mode:
authorJason Gerard DeRose <jderose@redhat.com>2008-08-14 09:01:02 +0000
committerJason Gerard DeRose <jderose@redhat.com>2008-08-14 09:01:02 +0000
commita3dc04ade4c8b640a881519144f009b70c6e4cfd (patch)
tree784866653de95cb28d295dc7e039bc53f392750e /ipalib/plugable.py
parentf0dfb9f873ccafcc77b34e36f03723d73f9c5e0c (diff)
downloadfreeipa.git-a3dc04ade4c8b640a881519144f009b70c6e4cfd.tar.gz
freeipa.git-a3dc04ade4c8b640a881519144f009b70c6e4cfd.tar.xz
freeipa.git-a3dc04ade4c8b640a881519144f009b70c6e4cfd.zip
157: More docstring cleanup; fixed remaining epydoc warnings
Diffstat (limited to 'ipalib/plugable.py')
-rw-r--r--ipalib/plugable.py14
1 files changed, 7 insertions, 7 deletions
diff --git a/ipalib/plugable.py b/ipalib/plugable.py
index 9fb3c079..ba4be6be 100644
--- a/ipalib/plugable.py
+++ b/ipalib/plugable.py
@@ -18,7 +18,7 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
-Base classes for plugin architecture.
+Generic plugin framework.
"""
import re
@@ -139,7 +139,7 @@ class Plugin(ReadOnly):
There are three different ways this can be called:
- 1. With a <type 'str'> argument, e.g.:
+ With a <type 'str'> argument, e.g.:
>>> class base(ProxyTarget):
>>> __public__ = frozenset(['some_attr', 'another_attr'])
@@ -148,14 +148,14 @@ class Plugin(ReadOnly):
>>> base.implements('an_unknown_attribute')
False
- 2. With a <type 'frozenset'> argument, e.g.:
+ With a <type 'frozenset'> argument, e.g.:
>>> base.implements(frozenset(['some_attr']))
True
>>> base.implements(frozenset(['some_attr', 'an_unknown_attribute']))
False
- 3. With any object that has a `__public__` attribute that is
+ With any object that has a `__public__` attribute that is
<type 'frozenset'>, e.g.:
>>> class whatever(object):
@@ -182,12 +182,12 @@ class Plugin(ReadOnly):
@classmethod
def implemented_by(cls, arg):
"""
- Returns True if.
+ Returns True if:
1. ``arg`` is an instance of or subclass of this class, and
2. ``arg`` (or ``arg.__class__`` if instance) has an attribute for
- each name in this class's ``__public__`` frozenset
+ each name in this class's ``__public__`` frozenset
Otherwise, returns False.
@@ -471,7 +471,7 @@ class NameSpace(ReadOnly):
class Registrar(ReadOnly):
def __init__(self, *allowed):
"""
- :param *allowed: Base classes from which plugins accepted by this
+ :param allowed: Base classes from which plugins accepted by this
Registrar must subclass.
"""
self.__allowed = frozenset(allowed)