[Django] #21942: document Form.clean() in "Forms API" docs
Django
--------------------------------------+------------------------------------
Reporter: cjerdonek | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.6
Severity: Normal | Keywords: forms,clean,validation
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Currently, the "Forms API" section of the Django docs (and in particular
the [https://docs.djangoproject.com/en/dev/ref/forms/api/#using-forms-to-
validate-data "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
[https://docs.djangoproject.com/en/dev/ref/forms/validation/ "Form and
field validation"] page, so perhaps the Forms API docs can link there for
its information (and/or vice versa).
--
Ticket URL: <https://code.djangoproject.com/ticket/21942>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: cjerdonek | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version: 1.6
Component: Documentation | Resolution:
Severity: Normal | Triage Stage:
Keywords: | Unreviewed
forms,clean,validation | Needs documentation: 0
Has patch: 0 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Changes (by cjerdonek):
* cc: chris.jerdonek@… (added)
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/21942#comment:1>
Django
Reporter: cjerdonek | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version: 1.6
Component: Documentation | Resolution:
Keywords: | Needs documentation: 0
forms,clean,validation | Patch needs improvement: 0
Has patch: 0 | UI/UX: 0
Needs tests: 0 |
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Changes (by timo):
* stage: Unreviewed => Accepted
Comment:
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/21942#comment:2>
Django
Reporter: cjerdonek | Owner: lkitchner
Type: | Status: assigned
Cleanup/optimization | Version: 1.6
Component: Documentation | Resolution:
Severity: Normal | Triage Stage: Accepted
Keywords: | Needs documentation: 0
forms,clean,validation | Patch needs improvement: 0
Has patch: 0 | UI/UX: 0
Needs tests: 0 |
Easy pickings: 1 |
-------------------------------------+-------------------------------------
* status: new => assigned
* owner: nobody => lkitchner
--
Ticket URL: <https://code.djangoproject.com/ticket/21942#comment:3>
Django
Reporter: cjerdonek | Owner: lkitchner
Type: | Status: assigned
Cleanup/optimization | Version: 1.6
Component: Documentation | Resolution:
Keywords: | checkin
forms,clean,validation | Needs documentation: 0
Has patch: 0 | Patch needs improvement: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Changes (by lkitchner):
* stage: Accepted => Ready for checkin
Comment:
I have submitted this fix to the GitHub repo. HTML generated with no
errors on Ubuntu.
--
Ticket URL: <https://code.djangoproject.com/ticket/21942#comment:4>
Django
Reporter: cjerdonek | Owner: lkitchner
Type: | Status: assigned
Cleanup/optimization | Version: 1.6
Component: Documentation | Resolution:
Keywords: | Needs documentation: 0
forms,clean,validation | Patch needs improvement: 0
Has patch: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Changes (by bmispelon):
* stage: Ready for checkin => Accepted
Comment:
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
--
Ticket URL: <https://code.djangoproject.com/ticket/21942#comment:5>
Django
Reporter: cjerdonek | Owner: lkitchner
Type: | Status: assigned
Cleanup/optimization | Version: 1.6
Component: Documentation | Resolution:
Severity: Normal | Triage Stage: Accepted
Keywords: | Needs documentation: 0
forms,clean,validation | Patch needs improvement: 0
Needs tests: 0 |
Easy pickings: 1 |
-------------------------------------+-------------------------------------
* has_patch: 0 => 1
Comment:
Here is the pull request: https://github.com/django/django/pull/2318
--
Ticket URL: <https://code.djangoproject.com/ticket/21942#comment:6>
Django
Reporter: cjerdonek | Owner: lkitchner
Type: | Status: assigned
Cleanup/optimization | Version: 1.6
Component: Documentation | Resolution:
Severity: Normal | Triage Stage: Accepted
Keywords: | Needs documentation: 0
Has patch: 1 | UI/UX: 0
Needs tests: 0 |
Easy pickings: 1 |
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
Comment:
Comments for improvement on the PR.
--
Ticket URL: <https://code.djangoproject.com/ticket/21942#comment:7>
Django
Reporter: cjerdonek | Owner: lkitchner
Type: | Status: assigned
Cleanup/optimization | Version: 1.6
Component: Documentation | Resolution:
Severity: Normal | Triage Stage: Accepted
Keywords: | Needs documentation: 0
forms,clean,validation | Patch needs improvement: 1
Has patch: 1 | UI/UX: 0
Needs tests: 0 |
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Comment (by lkitchner):
I've made the discussed changes from pull 2318 and have made a new pull
request.
https://github.com/django/django/pull/2334
--
Ticket URL: <https://code.djangoproject.com/ticket/21942#comment:8>
Django
Reporter: cjerdonek | Owner: lkitchner
Type: | Status: assigned
Cleanup/optimization | Version: 1.6
Component: Documentation | Resolution:
Severity: Normal | Triage Stage: Accepted
Keywords: | Needs documentation: 0
forms,clean,validation | Patch needs improvement: 1
Has patch: 1 | UI/UX: 0
Needs tests: 0 |
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Comment (by cjerdonek):
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
--
Ticket URL: <https://code.djangoproject.com/ticket/21942#comment:9>
Django
Reporter: cjerdonek | Owner: lkitchner
Cleanup/optimization | Version: 1.6
Component: Documentation | Resolution: fixed
Severity: Normal | Triage Stage: Accepted
Keywords: | Needs documentation: 0
forms,clean,validation | Patch needs improvement: 1
Has patch: 1 | UI/UX: 0
Needs tests: 0 |
Easy pickings: 1 |
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"874053edf92c02e1ab155bdf7491b08f9863dce8"]:
{{{
#!CommitTicketReference repository=""
revision="874053edf92c02e1ab155bdf7491b08f9863dce8"
Fixed #21942 -- Moved Form.clean() to form API docs.
Thanks cjerdonek for the suggestion.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/21942#comment:10>
Django
Reporter: cjerdonek | Owner: lkitchner
Type: | Status: closed
Cleanup/optimization | Version: 1.6
Component: Documentation | Resolution: fixed
Severity: Normal | Triage Stage: Accepted
Keywords: | Needs documentation: 0
forms,clean,validation | Patch needs improvement: 1
Has patch: 1 | UI/UX: 0
Needs tests: 0 |
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Comment (by Tim Graham <timograham@…>):
In [changeset:"af9949f4efe5c2a6fd51b925fe96e4a6644e2799"]:
{{{
#!CommitTicketReference repository=""
revision="af9949f4efe5c2a6fd51b925fe96e4a6644e2799"
[1.7.x] Fixed #21942 -- Moved Form.clean() to form API docs.
Thanks cjerdonek for the suggestion.
Backport of 874053edf9 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/21942#comment:11>