max_num limits total number of forms, not empty forms

[velle]

On: ​https://docs.djangoproject.com/en/1.6/topics/forms/formsets/

The documentation says: "The max_num parameter to formset_factory() gives you the ability to limit the maximum number of empty forms the formset will display".

I believe max_num limits the total number of forms, not the empty forms, or else the rest of the documentation on the page and the example do not make sense.

Also, right after the example they write: "If the value of max_num is greater than the number of existing objects, up to extra additional blank forms will be added to the formset, so long as the total number of forms does not exceed max_num."

They mention "objects". But if a newcomer to Django is reading the documentation on forms from one end to the other, he will not know what is meant by objects, when he hasnt yet read about ModelForms. I don't know how to deal with this. Maybe the ModelForm section could come before FormSet, but I have not thought that through.

[Collin Anderson]

It's true max_num limits the total number of forms, but it also allows you (with extra) to control the number of blank forms, but I agree it's a hair unclear.

Re objects: maybe rows or items? The example at the top simply uses an example article, even though it's not a model form.

Do you a clearer way to word these sentences?

[Daniele Procida]

I've marked this ticket as especially suitable for people following the ​Don't be afraid to commit tutorial at the DjangoCon US 2014 sprints.

If you're tackling this ticket, please don't hesitate to ask me for guidance if you'd like any, either at the sprints themselves, or here or on the Django IRC channels, where I can be found as EvilDMP.

[Aziz Alsaffar]

I'm picking this up at the don't be afraid to commit workshop in the djangocon sprints

[Aziz Alsaffar]

I am making changes in the following branch:

​https://github.com/Octowl/django/tree/ticket_23307

[Aziz Alsaffar]

Created a pull request at:

​https://github.com/django/django/pull/3187

[Tim Graham <timograham@…>]

In 5f3806b8612efca45dba1a75b29ad1bbbc12a7ca:

Fixed #23307 -- Clarified the way max_num limits the output of formsets.

Thanks velle for the report.

[Tim Graham <timograham@…>]

In 731654197cfbc49296c0d5869aae698b315440e9:

[1.6.x] Fixed #23307 -- Clarified the way max_num limits the output of formsets.

Thanks velle for the report.

Backport of 5f3806b861 from master

[Tim Graham <timograham@…>]

In 813619405b4920c44f455b23ef407c6c66eb5746:

[1.7.x] Fixed #23307 -- Clarified the way max_num limits the output of formsets.

Thanks velle for the report.

Backport of 5f3806b861 from master