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:30:57 -0400
commit874053edf92c02e1ab155bdf7491b08f9863dce8 (patch)
tree551ea3b5e96f19e133e2b403463fd20cdf7decbb /docs/ref/forms/api.txt
parent29c1151a5577cccfdb18109ccb42330cde124d89 (diff)
Fixed #21942 -- Moved Form.clean() to form API docs.
Thanks cjerdonek for the suggestion.
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 8909d5c916..954d14e184 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