summaryrefslogtreecommitdiffstats
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:51 +0200
commit85d634c108d4b38678ac7bc6076a8512722d7d16 (patch)
tree62fc418a6e27a9362a9c414af5f190f14bb26f2d
parent04d0215efb2ab9ec73827f2777689aed99d4931e (diff)
downloadfreeipa.git-85d634c108d4b38678ac7bc6076a8512722d7d16.tar.gz
freeipa.git-85d634c108d4b38678ac7bc6076a8512722d7d16.tar.xz
freeipa.git-85d634c108d4b38678ac7bc6076a8512722d7d16.zip
Document the 'nonempty' flag
Missing documentation for commit 7cfc16c/c6e4372
-rw-r--r--ipalib/parameters.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/ipalib/parameters.py b/ipalib/parameters.py
index 5c55d8bc..35dbdd95 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`