summaryrefslogtreecommitdiff
path: root/docs/ref/forms/api.txt
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2014-06-30 16:30:57 -0400
committerTim Graham <timograham@gmail.com>2014-06-30 16:32:03 -0400
commitaf9949f4efe5c2a6fd51b925fe96e4a6644e2799 (patch)
tree14507d13ea8ed8db97732a64e1064546a294de51 /docs/ref/forms/api.txt
parent92609560841b2dd3df2d4dfa3e8ac2fe732da885 (diff)
[1.7.x] Fixed #21942 -- Moved Form.clean() to form API docs.
Thanks cjerdonek for the suggestion. Backport of 874053edf9 from master
Diffstat (limited to 'docs/ref/forms/api.txt')
-rw-r--r--docs/ref/forms/api.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt
index 3b687ed73d..48c6fadca1 100644
--- a/docs/ref/forms/api.txt
+++ b/docs/ref/forms/api.txt
@@ -71,6 +71,12 @@ should consider its data immutable, whether it has data or not.
Using forms to validate data
----------------------------
+.. method:: Form.clean()
+
+Implement a ``clean()`` method on your ``Form`` when you must add custom
+validation for fields that are interdependent. See
+:ref:`validating-fields-with-clean` for example usage.
+
.. method:: Form.is_valid()
The primary task of a :class:`Form` object is to validate data. With a bound