document Form.clean() in "Forms API" docs

[Chris Jerdonek]

Currently, the "Forms API" section of the Django docs (and in particular the ​Using forms to validate data section of that page), does not document Form.clean(), though the Form.add_error() documentation in that page references it.

There is some documentation about Form.clean() in the ​Form and field validation page, so perhaps the Forms API docs can link there for its information (and/or vice versa).

[Tim Graham]

Yes, I would add it under "Using forms to validate data" and move ".. method:: django.forms.Form.clean()" from the "Cleaning and validating fields that depend on each other" section of ref/forms/validation.txt, but then link to that section from the new text in the API doc.

[lkitchner]

I have submitted this fix to the GitHub repo. HTML generated with no errors on Ubuntu.

[Baptiste Mispelon]

The "ready for checkin" status is for when your patch has been reviewed and is ready to be checked in (see relevant documentation [1]).

I cannot see your fix anywhere: did you submit it as a pull request?

When you have a pull request, please put the link as a comment on this ticket as check the "has patch" checkbox.

Thanks.

[1] ​https://docs.djangoproject.com/en/1.6/internals/contributing/triaging-tickets/#triage-stages

[lkitchner]

Here is the pull request: ​https://github.com/django/django/pull/2318

[Tim Graham]

Comments for improvement on the PR.

[lkitchner]

I've made the discussed changes from pull 2318 and have made a new pull request.
​https://github.com/django/django/pull/2334

[Chris Jerdonek]

I made a suggestion on the first pull request that doesn't seem to be reflected in the second one (nor was there a response): ​https://github.com/django/django/pull/2318#discussion_r9840517

[Tim Graham <timograham@…>]

In 874053edf92c02e1ab155bdf7491b08f9863dce8:

Fixed #21942 -- Moved Form.clean() to form API docs.

Thanks cjerdonek for the suggestion.

[Tim Graham <timograham@…>]

In af9949f4efe5c2a6fd51b925fe96e4a6644e2799:

[1.7.x] Fixed #21942 -- Moved Form.clean() to form API docs.

Thanks cjerdonek for the suggestion.

Backport of 874053edf9 from master