summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMalcolm Tredinnick <malcolm.tredinnick@gmail.com>2007-04-27 15:06:45 +0000
committerMalcolm Tredinnick <malcolm.tredinnick@gmail.com>2007-04-27 15:06:45 +0000
commitec577d88eaf4093725fb78e50be7756f27b5d5d0 (patch)
treebc58cd94fa2c6d9b5ae8af6e17d02fe465ca2e42 /docs
parent8a4a8023d61cb31093db7b511e58ea3502e47cb6 (diff)
Fixed up some omissions and one mysteriously documented, yet non-existent field
in the validator documentation. Patch from alang@bright-green.com. Refs #2266. git-svn-id: http://code.djangoproject.com/svn/django/trunk@5113 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
-rw-r--r--docs/forms.txt20
1 files changed, 12 insertions, 8 deletions
diff --git a/docs/forms.txt b/docs/forms.txt
index 144b70f13b..329e84a1b1 100644
--- a/docs/forms.txt
+++ b/docs/forms.txt
@@ -517,7 +517,7 @@ to put punctuation at the end of your validation messages.
When are validators called?
---------------------------
-After a form has been submitted, Django validates each field in turn. First,
+After a form has been submitted, Django validates each field in turn. First,
if the field is required, Django checks that it is present and non-empty. Then,
if that test passes *and the form submission contained data* for that field, all
the validators for that field are called in turn. The emphasized portion in the
@@ -615,15 +615,19 @@ fails. If no message is passed in, a default message is used.
``other_value``, then the validators in ``validator_list`` are all run
against the current field.
+``RequiredIfOtherFieldGiven``
+ Takes a field name of the current field is only required if the other
+ field has a value.
+
+``RequiredIfOtherFieldsGiven``
+ Similar to ``RequiredIfOtherFieldGiven``, except that it takes a list of
+ field names and if any one of the supplied fields has a value provided,
+ the current field being validated is required.
+
``RequiredIfOtherFieldNotGiven``
Takes the name of the other field and this field is only required if the
other field has no value.
-``RequiredIfOtherFieldsNotGiven``
- Similar to ``RequiredIfOtherFieldNotGiven``, except that it takes a list
- of field names and if any one of the supplied fields does not have a value
- provided, the field being validated is required.
-
``RequiredIfOtherFieldEquals`` and ``RequiredIfOtherFieldDoesNotEqual``
Each of these validator classes takes a field name and a value (in that
order). If the given field does (or does not have, in the latter case) the
@@ -650,8 +654,8 @@ fails. If no message is passed in, a default message is used.
``NumberIsInRange``
Takes two boundary numbers, ``lower`` and ``upper``, and checks that the
field is greater than ``lower`` (if given) and less than ``upper`` (if
- given).
-
+ given).
+
Both checks are inclusive. That is, ``NumberIsInRange(10, 20)`` will allow
values of both 10 and 20. This validator only checks numeric values
(e.g., float and integer values).