summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2013-01-11 05:59:17 -0500
committerTim Graham <timograham@gmail.com>2013-01-11 06:01:19 -0500
commitc94fcc4117987c4ebe29ad63da01035230c8afd5 (patch)
treedbfd1aea65424f2f8cfb47cfcc30b581996f6cfe /docs/ref
parent72ef63bf86b12e752f186d562d9094cfde30af27 (diff)
[1.5.x] Fixed #10239 - Added docs for modelform_factory
Thanks ingenieroariel for the suggestion and slurms for the review. Backport of 71d76ec011 from master
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/forms/index.txt1
-rw-r--r--docs/ref/forms/models.txt40
2 files changed, 41 insertions, 0 deletions
diff --git a/docs/ref/forms/index.txt b/docs/ref/forms/index.txt
index 866afed6dc..446fdb82de 100644
--- a/docs/ref/forms/index.txt
+++ b/docs/ref/forms/index.txt
@@ -9,5 +9,6 @@ Detailed form API reference. For introductory material, see :doc:`/topics/forms/
api
fields
+ models
widgets
validation
diff --git a/docs/ref/forms/models.txt b/docs/ref/forms/models.txt
new file mode 100644
index 0000000000..1f4a0d0c3d
--- /dev/null
+++ b/docs/ref/forms/models.txt
@@ -0,0 +1,40 @@
+====================
+Model Form Functions
+====================
+
+.. module:: django.forms.models
+ :synopsis: Django's functions for building model forms and formsets.
+
+.. method:: modelform_factory(model, form=ModelForm, fields=None, exclude=None, formfield_callback=None, widgets=None)
+
+ Returns a :class:`~django.forms.ModelForm` class for the given ``model``.
+ You can optionally pass a ``form`` argument to use as a starting point for
+ constructing the ``ModelForm``.
+
+ ``fields`` is an optional list of field names. If provided, only the named
+ fields will be included in the returned fields.
+
+ ``exclude`` is an optional list of field names. If provided, the named
+ fields will be excluded from the returned fields, even if they are listed
+ in the ``fields`` argument.
+
+ ``widgets`` is a dictionary of model field names mapped to a widget.
+
+ ``formfield_callback`` is a callable that takes a model field and returns
+ a form field.
+
+ See :ref:`modelforms-factory` for example usage.
+
+.. method:: modelformset_factory(model, form=ModelForm, formfield_callback=None, formset=BaseModelFormSet, extra=1, can_delete=False, can_order=False, max_num=None, fields=None, exclude=None)
+
+ Returns a ``FormSet`` class for the given ``model`` class.
+
+ Arguments ``model``, ``form``, ``fields``, ``exclude``, and
+ ``formfield_callback`` are all passed through to
+ :meth:`~django.forms.models.modelform_factory`.
+
+ Arguments ``formset``, ``extra``, ``max_num``, ``can_order``, and
+ ``can_delete`` are passed through to ``formset_factory``. See
+ :ref:`formsets` for details.
+
+ See :ref:`model-formsets` for example usage.