Fixed #11374 -- Modified the documentation for forms.BooleanField to allow for the fact that it can be rendered using widgets other than a checkbox. Thanks to lygaret for the patch.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@11236 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Russell Keith-Magee 2009-07-15 13:54:11 +00:00
parent e114cbf3de
commit 75514ab7bc
1 changed files with 21 additions and 20 deletions

View File

@ -275,7 +275,7 @@ For each field, we describe the default widget used if you don't specify
* Default widget: ``CheckboxInput`` * Default widget: ``CheckboxInput``
* Empty value: ``False`` * Empty value: ``False``
* Normalizes to: A Python ``True`` or ``False`` value. * Normalizes to: A Python ``True`` or ``False`` value.
* Validates that the check box is checked (i.e. the value is ``True``) if * Validates that the value is ``True`` (e.g. the check box is checked) if
the field has ``required=True``. the field has ``required=True``.
* Error message keys: ``required`` * Error message keys: ``required``
@ -287,9 +287,10 @@ For each field, we describe the default widget used if you don't specify
.. note:: .. note::
Since all ``Field`` subclasses have ``required=True`` by default, the Since all ``Field`` subclasses have ``required=True`` by default, the
validation condition here is important. If you want to include a checkbox validation condition here is important. If you want to include a boolean
in your form that can be either checked or unchecked, you must remember to in your form that can be either ``True`` or ``False`` (e.g. a checked or
pass in ``required=False`` when creating the ``BooleanField``. unchecked checkbox), you must remember to pass in ``required=False`` when
creating the ``BooleanField``.
``CharField`` ``CharField``
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
@ -328,7 +329,7 @@ Takes one extra required argument:
An iterable (e.g., a list or tuple) of 2-tuples to use as choices for this An iterable (e.g., a list or tuple) of 2-tuples to use as choices for this
field. field.
``TypedChoiceField`` ``TypedChoiceField``
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
@ -437,7 +438,7 @@ If no ``input_formats`` argument is provided, the default input formats are::
``min_value``, ``max_digits``, ``max_decimal_places``, ``min_value``, ``max_digits``, ``max_decimal_places``,
``max_whole_digits`` ``max_whole_digits``
Takes four optional arguments: Takes four optional arguments:
.. attribute:: DecimalField.max_value .. attribute:: DecimalField.max_value
.. attribute:: DecimalField.min_value .. attribute:: DecimalField.min_value
@ -449,7 +450,7 @@ Takes four optional arguments:
The maximum number of digits (those before the decimal point plus those The maximum number of digits (those before the decimal point plus those
after the decimal point, with leading zeros stripped) permitted in the after the decimal point, with leading zeros stripped) permitted in the
value. value.
.. attribute:: DecimalField.decimal_places .. attribute:: DecimalField.decimal_places
The maximum number of decimal places permitted. The maximum number of decimal places permitted.
@ -522,18 +523,18 @@ extra arguments; only ``path`` is required:
A regular expression pattern; only files with names matching this expression A regular expression pattern; only files with names matching this expression
will be allowed as choices. will be allowed as choices.
``FloatField`` ``FloatField``
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
* Default widget: ``TextInput`` * Default widget: ``TextInput``
* Empty value: ``None`` * Empty value: ``None``
* Normalizes to: A Python float. * Normalizes to: A Python float.
* Validates that the given value is an float. Leading and trailing * Validates that the given value is an float. Leading and trailing
whitespace is allowed, as in Python's ``float()`` function. whitespace is allowed, as in Python's ``float()`` function.
* Error message keys: ``required``, ``invalid``, ``max_value``, * Error message keys: ``required``, ``invalid``, ``max_value``,
``min_value`` ``min_value``
Takes two optional arguments for validation, ``max_value`` and ``min_value``. Takes two optional arguments for validation, ``max_value`` and ``min_value``.
These control the range of values permitted in the field. These control the range of values permitted in the field.
``ImageField`` ``ImageField``
@ -779,10 +780,10 @@ example::
(which is ``"---------"`` by default) with the ``empty_label`` attribute, or (which is ``"---------"`` by default) with the ``empty_label`` attribute, or
you can disable the empty label entirely by setting ``empty_label`` to you can disable the empty label entirely by setting ``empty_label`` to
``None``:: ``None``::
# A custom empty label # A custom empty label
field1 = forms.ModelChoiceField(queryset=..., empty_label="(Nothing)") field1 = forms.ModelChoiceField(queryset=..., empty_label="(Nothing)")
# No empty label # No empty label
field2 = forms.ModelChoiceField(queryset=..., empty_label=None) field2 = forms.ModelChoiceField(queryset=..., empty_label=None)