diff options
| author | Tim Graham <timograham@gmail.com> | 2013-01-22 06:46:22 -0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2013-01-22 07:55:34 -0500 |
| commit | 5b2d9bacd2512bcdf371c05b0b43bc713dcca080 (patch) | |
| tree | 329b7c59d71bbc6db3979a5d8eaed860bb95c6d6 /docs/ref/forms | |
| parent | e535da6865f0e02f0b593b52ed2e040b24a886d6 (diff) | |
Fixed #19640 - Added inlineformset_factory to reference docs.
Thanks wim@ for the suggestion.
Diffstat (limited to 'docs/ref/forms')
| -rw-r--r-- | docs/ref/forms/models.txt | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/ref/forms/models.txt b/docs/ref/forms/models.txt index 1f4a0d0c3d..c388f402e6 100644 --- a/docs/ref/forms/models.txt +++ b/docs/ref/forms/models.txt @@ -5,7 +5,7 @@ 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) +.. function:: 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 @@ -25,16 +25,27 @@ Model Form Functions 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) +.. function:: 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`. + :func:`~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. + +.. function:: inlineformset_factory(parent_model, model, form=ModelForm, formset=BaseInlineFormSet, fk_name=None, fields=None, exclude=None, extra=3, can_order=False, can_delete=True, max_num=None, formfield_callback=None) + + Returns an ``InlineFormSet`` using :func:`modelformset_factory` with + defaults of ``formset=BaseInlineFormSet``, ``can_delete=True``, and + ``extra=3``. + + If your model has more than one :class:`~django.db.models.ForeignKey` to + the ``parent_model``, you must specify a ``fk_name``. + + See :ref:`inline-formsets` for example usage. |
