summaryrefslogtreecommitdiffstats
path: root/ipalib
diff options
context:
space:
mode:
authorPetr Viktorin <pviktori@redhat.com>2012-04-13 09:13:50 -0400
committerMartin Kosek <mkosek@redhat.com>2012-04-13 15:45:41 +0200
commit98e662b96f4e533693465131675ae01f777bde4e (patch)
tree03039cfad3e896ee378511fc55d25e418cde9469 /ipalib
parent2584e9be673985d530447b836b38cb4ddbf8ee21 (diff)
downloadfreeipa-98e662b96f4e533693465131675ae01f777bde4e.tar.gz
freeipa-98e662b96f4e533693465131675ae01f777bde4e.tar.xz
freeipa-98e662b96f4e533693465131675ae01f777bde4e.zip
Document the 'nonempty' flag
Missing documentation for commit 7cfc16c/c6e4372
Diffstat (limited to 'ipalib')
-rw-r--r--ipalib/parameters.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/ipalib/parameters.py b/ipalib/parameters.py
index 5c55d8bcc..35dbdd957 100644
--- a/ipalib/parameters.py
+++ b/ipalib/parameters.py
@@ -343,6 +343,12 @@ class Param(ReadOnly):
is not `required`. Applied for all crud.Update based commands
* req_update: The parameter is `required` in all crud.Update based
commands
+ * nonempty: This is an internal flag; a required attribute should
+ be used instead of it.
+ The value of this parameter must not be empty, but it may
+ not be given at all. All crud.Update commands automatically
+ convert required parameters to `nonempty` ones, so the value
+ can be unspecified (unchanged) but cannot be deleted.
- hint: this attribute is currently not used
- alwaysask: when enabled, CLI asks for parameter value even when the
parameter is not `required`