Author: timo
Date: 2010-12-28 15:10:19 -0600 (Tue, 28 Dec 2010)
New Revision: 15080
Modified:
django/trunk/docs/ref/forms/fields.txt
Log:
Fixed #14708 - Document available keys for form field error messages; thanks
adamv.
Modified: django/trunk/docs/ref/forms/fields.txt
===================================================================
--- django/trunk/docs/ref/forms/fields.txt 2010-12-28 13:36:12 UTC (rev
15079)
+++ django/trunk/docs/ref/forms/fields.txt 2010-12-28 21:10:19 UTC (rev
15080)
@@ -340,6 +340,9 @@
* Validates that the given value exists in the list of choices.
* Error message keys: ``required``, ``invalid_choice``
+The ``invalid_choice`` error message may contain ``%(value)s``, which will be
+replaced with the selected choice.
+
Takes one extra required argument:
.. attribute:: ChoiceField.choices
@@ -449,6 +452,9 @@
``min_value``, ``max_digits``, ``max_decimal_places``,
``max_whole_digits``
+The ``max_value`` and ``min_value`` error messages may contain
+``%(limit_value)s``, which will be substituted by the appropriate limit.
+
Takes four optional arguments:
.. attribute:: DecimalField.max_value
@@ -497,7 +503,8 @@
* Normalizes to: An ``UploadedFile`` object that wraps the file content
and file name into a single object.
* Validates that non-empty file data has been bound to the form.
- * Error message keys: ``required``, ``invalid``, ``missing``, ``empty``
+ * Error message keys: ``required``, ``invalid``, ``missing``, ``empty``,
+ ``max_length``
To learn more about the ``UploadedFile`` object, see the :doc:`file uploads
documentation </topics/http/file-uploads>`.
@@ -505,6 +512,10 @@
When you use a ``FileField`` in a form, you must also remember to
:ref:`bind the file data to the form <binding-uploaded-files>`.
+The ``max_length`` error refers to the length of the filename. In the error
+message for that key, ``%(max)d`` will be replaced with the maximum filename
+length and ``%(length)d`` will be replaced with the current filename length.
+
``FilePathField``
~~~~~~~~~~~~~~~~~
@@ -583,6 +594,9 @@
* Error message keys: ``required``, ``invalid``, ``max_value``,
``min_value``
+The ``max_value`` and ``min_value`` error messages may contain
+``%(limit_value)s``, which will be substituted by the appropriate limit.
+
Takes two optional arguments for validation:
.. attribute:: IntegerField.max_value
@@ -614,6 +628,9 @@
of choices.
* Error message keys: ``required``, ``invalid_choice``, ``invalid_list``
+The ``invalid_choice`` error message may contain ``%(value)s``, which will be
+replaced with the selected choice.
+
Takes one extra required argument, ``choices``, as for ``ChoiceField``.
``TypedMultipleChoiceField``
@@ -632,6 +649,9 @@
coerced.
* Error message keys: ``required``, ``invalid_choice``
+The ``invalid_choice`` error message may contain ``%(value)s``, which will be
+replaced with the selected choice.
+
Takes two extra arguments, ``coerce`` and ``empty_value``, as for
``TypedChoiceField``.
``NullBooleanField``
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to django-upda...@googlegroups.com.
To unsubscribe from this group, send email to
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
