Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity

[1.2.X] Fixed #14708 - Document available keys for form field error messages; thanks adamv.

Browse Source 
Backport of r15080 from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@15081 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Timo Graham 2010-12-28 21:16:25 +00:00
parent 483cddf23e
commit 031eb9983e
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/ref/forms/fields.txt
View File

@ -340,6 +340,9 @@ Has two optional arguments for validation:
* 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
@ -452,6 +455,9 @@ If no ``input_formats`` argument is provided, the default input formats are::
``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
@ -500,7 +506,8 @@ given length.
* 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>`.
@ -508,6 +515,10 @@ documentation </topics/http/file-uploads>`.
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``
~~~~~~~~~~~~~~~~~
@ -586,6 +597,9 @@ When you use an ``ImageField`` on a form, you must also remember to
* 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
@ -617,7 +631,10 @@ Takes two optional arguments for validation:
of choices.
* Error message keys: ``required``, ``invalid_choice``, ``invalid_list``
Takes one extra argument, ``choices``, as for ``ChoiceField``.
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``.
``NullBooleanField``
~~~~~~~~~~~~~~~~~~~~