summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason Gerard DeRose <jderose@redhat.com>2008-09-27 00:31:59 +0000
committerJason Gerard DeRose <jderose@redhat.com>2008-09-27 00:31:59 +0000
commit8901b9a8379c37e6243a24eec9648afa05638785 (patch)
treedf1182c5141717f195ce4d077b17d21d74cc6de6
parent031daabcc4bb023ff54bd76dd1418bbe3bcff022 (diff)
downloadfreeipa-8901b9a8379c37e6243a24eec9648afa05638785.tar.gz
freeipa-8901b9a8379c37e6243a24eec9648afa05638785.tar.xz
freeipa-8901b9a8379c37e6243a24eec9648afa05638785.zip
372: Started work on docstring for Param class
-rw-r--r--ipalib/frontend.py17
1 files changed, 15 insertions, 2 deletions
diff --git a/ipalib/frontend.py b/ipalib/frontend.py
index 5fd27116d..77518a96b 100644
--- a/ipalib/frontend.py
+++ b/ipalib/frontend.py
@@ -194,17 +194,30 @@ def parse_param_spec(spec):
class Param(plugable.ReadOnly):
"""
A parameter accepted by a `Command`.
+
+ ============ ================= ==================
+ Keyword Type Default
+ ============ ================= ==================
+ type ipa_type.Type ipa_type.Unicode()
+ doc str ''
+ required bool True
+ multivalue bool False
+ primary_key bool False
+ normalize callable None
+ default same as type.type None
+ default_from callable None
+ ============ ================= ==================
"""
__nones = (None, '', tuple(), [])
__defaults = dict(
doc='',
required=True,
multivalue=False,
+ primary_key=False,
+ normalize=None,
default=None,
default_from=None,
rules=tuple(),
- normalize=None,
- primary_key=False,
)
def __init__(self, name, type_=ipa_types.Unicode(), **override):