Document modelform_factory

[ingenieroariel]

​modelform_factory is not documented in ​http://docs.djangoproject.com/en/dev/topics/forms/modelforms/

[Jacob]

I think modelform_factory is considered internal -- it's used by modelformset_factory -- and thus shouldn't be documented along with the public code. Nevertheless, in an idea world everything ought to be documented somewhere!

[fas]

I didn't know it is considered internal, I use it very often. The formfield_callback to modify the form fields that are created for the corresponding db fields is in many cases much more useful/easier than defining the form field anew and pass all parameters explicitly (rather than having them being drawn from the model). The documentation also points out this shortcoming (Note box at ​http://docs.djangoproject.com/en/dev/topics/forms/modelforms/#overriding-the-default-field-types-or-widgets.

Any chance of making this method public?

[Chris Beaven]

I'm going to push this back to a design decision and mark it as a feature (the feature being the addition of this method to the documented public forms API).

Bring a discussion to the django-dev group.

[Will Hardy]

Added documentation for modelform_factory

[Peter van Kampen]

Thank you. This looks good. Would it make sense to include the function's signature in modelforms.txt?

[Gabriel Hurley]

While I can understand that this method may have been originally considered internal, I don't see any significant reason why it is more internal than modelformset_factory, which is documented. Additionally, I've certainly seen it in use by the community in numerous places. Changing it substantially in a backwards-incompatible way without documentation would be detrimental at this stage.

As for this patch, there's a significant typo on line 540: "modelformset_factory" should be "modelform_factory".

However, what really bothers is that the only documentation for ModelForm and modelformset_factory right now is in the topic guide. There direly needs to be a API reference for these in addition to just adding another section to the topic guide.

If this patch expands to include a reference doc (new) as well as the existing improvements then I'd be willing to commit it.

[Tim Graham]

I'll add some reference docs to this.

[Tim Graham]

Added an expanded patch with reference docs for modelform_factory and modelformset_factory.

[Nick Sandford]

The patch misses a newline after .. note:: on line 173. Other than that it looks good.

[Tim Graham <timograham@…>]

In 71d76ec011b393990ba9f5fb63727dbe36c3c440:

Fixed #10239 - Added docs for modelform_factory

Thanks ingenieroariel for the suggestion and slurms for the review.

[Tim Graham <timograham@…>]

In c94fcc4117987c4ebe29ad63da01035230c8afd5:

[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

[Tim Graham <timograham@…>]

In c94fcc4117987c4ebe29ad63da01035230c8afd5:

[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