Formset documentation has no information about practical formset validation

[aidan]

Although the clean method is demonstrated, no actual validation is demonstrated.

It is unclear whether self.forms should be iterated and cleaned_data examined - a property which may or may not exist.

[Andrew Badr]

This patch adds a more realistic example to the formset-level clean method. It also expands the first example in the "Formset validation" section so that it matches the later example, and to better explain the contents of formset.errors.

Like several methods in the internal formset code, the example clean in this patch iterates only through the first self.total_form_count() entries in self.forms. This seems to be safer than iterating self.forms directly, because we may not use all the initial forms, or we may try to use more than max_num. If I'm wrong about this, the example clean should be changed to simply iterate through self.forms directly. That's what some other methods do, and I'm not confident that I understand the difference.

Also, my clean method accesses the forms' cleaned_data manually instead of using the formset's self.cleaned_data. This is mainly because of a comment on self.cleaned_data saying "Maybe this should just go away?", but also because self.cleaned_data iterates through self.forms, which I'm confused about (see above). If this is changed, the guard checking any(self.errors) must be kept, or else users accessing self.cleaned_data with form-level validation errors will get an uncaught exception.

[Andrew Badr]

Also, this is my first documentation patch. Did my changes overstep the bounds of the ticket by too much? I'm worried that the first validation example is now a little clunky. Critique is welcome.

[Russell Keith-Magee]

(In 11234] Fixed #10287 -- Added better examples in the docs of formset validation. Thanks to Andrew Badr for the text.

[Russell Keith-Magee]

(In [11241]) [1.0.X] Fixed #10287 -- Added better examples in the docs of formset validation. Thanks to Andrew Badr for the text.

Merge of r11234 from trunk.

[Jacob]

Milestone 1.1 deleted