Commit 214fb700 authored by Tim Graham's avatar Tim Graham
Browse files

Fixed #19477 - Documented generic_inlineformset_factory

Thanks epicserve for the suggestion.
parent 5b2d9bac
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -429,7 +429,7 @@ def generic_inlineformset_factory(model, form=ModelForm,
                                  max_num=None,
                                  formfield_callback=None):
    """
    Returns an ``GenericInlineFormSet`` for the given kwargs.
    Returns a ``GenericInlineFormSet`` for the given kwargs.

    You must provide ``ct_field`` and ``object_id`` if they different from the
    defaults ``content_type`` and ``object_id`` respectively.
+23 −8
Original line number Diff line number Diff line
@@ -452,14 +452,18 @@ need to calculate them without using the aggregation API.
Generic relations in forms and admin
------------------------------------

The :mod:`django.contrib.contenttypes.generic` module provides
``BaseGenericInlineFormSet``,
:class:`~django.contrib.contenttypes.generic.GenericTabularInline`
The :mod:`django.contrib.contenttypes.generic` module provides:

* ``BaseGenericInlineFormSet``
* :class:`~django.contrib.contenttypes.generic.GenericTabularInline`
  and :class:`~django.contrib.contenttypes.generic.GenericStackedInline`
(the last two are subclasses of
:class:`~django.contrib.contenttypes.generic.GenericInlineModelAdmin`).
This enables the use of generic relations in forms and the admin. See the
:doc:`model formset </topics/forms/modelforms>` and
  (subclasses of
  :class:`~django.contrib.contenttypes.generic.GenericInlineModelAdmin`)
* A formset factory, :func:`generic_inlineformset_factory`, for use with
  :class:`GenericForeignKey`

These classes and functions enable the use of generic relations in forms
and the admin. See the :doc:`model formset </topics/forms/modelforms>` and
:ref:`admin <using-generic-relations-as-an-inline>` documentation for more
information.

@@ -486,3 +490,14 @@ information.

    Subclasses of :class:`GenericInlineModelAdmin` with stacked and tabular
    layouts, respectively.

.. function:: generic_inlineformset_factory(model, form=ModelForm, formset=BaseGenericInlineFormSet, ct_field="content_type", fk_field="object_id", fields=None, exclude=None, extra=3, can_order=False, can_delete=True, max_num=None, formfield_callback=None)

    Returns a ``GenericInlineFormSet`` using
    :func:`~django.forms.models.modelformset_factory`.

    You must provide ``ct_field`` and ``object_id`` if they different from the
    defaults, ``content_type`` and ``object_id`` respectively. Other parameters
    are similar to those documented in
    :func:`~django.forms.models.modelformset_factory` and
    :func:`~django.forms.models.inlineformset_factory`.