Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#21942 closed Cleanup/optimization (fixed)

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

Reported by: Chris Jerdonek Owned by: lkitchner
Component: Documentation Version: 1.6
Severity: Normal Keywords: forms, clean, validation
Cc: chris.jerdonek@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: yes UI/UX: no

Description

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).

Change History (11)

comment:1 by Chris Jerdonek, 10 years ago

Cc: chris.jerdonek@… added

comment:2 by Tim Graham, 10 years ago

Triage Stage: UnreviewedAccepted

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.

comment:3 by lkitchner, 10 years ago

Owner: changed from nobody to lkitchner
Status: newassigned

comment:4 by lkitchner, 10 years ago

Triage Stage: AcceptedReady for checkin

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

comment:5 by Baptiste Mispelon, 10 years ago

Triage Stage: Ready for checkinAccepted

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

comment:6 by lkitchner, 10 years ago

Has patch: set

comment:7 by Tim Graham, 10 years ago

Patch needs improvement: set

Comments for improvement on the PR.

comment:8 by lkitchner, 10 years ago

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

comment:9 by Chris Jerdonek, 10 years ago

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

comment:10 by Tim Graham <timograham@…>, 10 years ago

Resolution: fixed
Status: assignedclosed

In 874053edf92c02e1ab155bdf7491b08f9863dce8:

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

Thanks cjerdonek for the suggestion.

comment:11 by Tim Graham <timograham@…>, 10 years ago

In af9949f4efe5c2a6fd51b925fe96e4a6644e2799:

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

Thanks cjerdonek for the suggestion.

Backport of 874053edf9 from master

Note: See TracTickets for help on using tickets.
Back to Top