IntenseWebs/freeipa
3
0
Fork 0
mirror of https://salsa.debian.org/freeipa-team/freeipa.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

New Param: Small docstring change in Flag

Browse Source
This commit is contained in:
Jason Gerard DeRose 2009-01-14 10:17:39 -07:00
parent 05514292dc
commit cc5d7e8adb
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
ipalib/parameter.py
View File

@ -632,6 +632,7 @@ class Bool(Param):
"""
type = bool
type_error = _('must be True or False')
class Flag(Bool):
@ -645,16 +646,23 @@ class Flag(Bool):
For example:
>>> Flag('my_flag')
Flag('my_flag', autofill=True, default=False)
>>> Flag('my_flag', default=True) # Do this for default of True
Flag('my_flag', autofill=True, default=True)
>>> flag = Flag('my_flag')
>>> (flag.autofill, flag.default)
(True, False)
To have a default value of ``True``, create your `Flag` intance with
``default=True``. For example:
>>> flag = Flag('my_flag', default=True)
>>> (flag.autofill, flag.default)
(True, True)
Also note that creating a `Flag` instance with ``autofill=False`` will have
no effect. For example:
>>> Flag('my_flag', autofill=False) # autofill will still be True
Flag('my_flag', autofill=True, default=False)
>>> flag = Flag('my_flag', autofill=False)
>>> flag.autofill
True
"""
def __init__(self, name, *rules, **kw):