summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGabriel Hurley <gabehr@gmail.com>2010-10-14 10:03:08 +0000
committerGabriel Hurley <gabehr@gmail.com>2010-10-14 10:03:08 +0000
commit767cf955d25d0ab82e6b9bd4b6360a1ccef15706 (patch)
treeef51ea1dcb76cc7e8ba2eb5e52bfbb012f3d61fa /docs
parent8d364763ed45f4298ac3395f41252e21e82f9f28 (diff)
Fixed #5327 -- Added standardized field information to ModelChoiceField and ModelMultipleChoiceField documentation. Thanks to danielrubio for the report and PhiR for the text.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@14214 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/forms/fields.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt
index ce86a0cb34..5c482afd22 100644
--- a/docs/ref/forms/fields.txt
+++ b/docs/ref/forms/fields.txt
@@ -856,6 +856,12 @@ objects (in the case of ``ModelMultipleChoiceField``) into the
.. class:: ModelChoiceField(**kwargs)
+ * Default widget: ``Select``
+ * Empty value: ``None``
+ * Normalizes to: A model instance.
+ * Validates that the given id exists in the queryset.
+ * Error message keys: ``required``, ``invalid_choice``
+
Allows the selection of a single model object, suitable for
representing a foreign key. A single argument is required:
@@ -901,6 +907,14 @@ example::
.. class:: ModelMultipleChoiceField(**kwargs)
+ * Default widget: ``SelectMultiple``
+ * Empty value: ``[]`` (an empty list)
+ * Normalizes to: A list of model instances.
+ * Validates that every id in the given list of values exists in the
+ queryset.
+ * Error message keys: ``required``, ``list``, ``invalid_choice``,
+ ``invalid_pk_value``
+
Allows the selection of one or more model objects, suitable for
representing a many-to-many relation. As with :class:`ModelChoiceField`,
you can use ``label_from_instance`` to customize the object