[Django] #27387: Rendering "required" as HTML attribute is not documented
Django
--------------------------------------+--------------------
Reporter: karyon | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Forms | Version: 1.10
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+--------------------
https://docs.djangoproject.com/en/1.10/releases/1.10/#forms says
{{{
Required form fields now have the required HTML attribute. Set the new
Form.use_required_attribute attribute to False to disable it. The required
attribute isn’t included on forms of formsets because the browser
validation may not be correct when adding and deleting formsets.
}}}
i would expect all of that (it's rendered, can be disabled, isn't rendered
in formsets) to appear somewhere around
https://docs.djangoproject.com/el/1.10/ref/forms/fields/#required, but it
does not.
--
Ticket URL: <https://code.djangoproject.com/ticket/27387>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: karyon | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Forms | Version: 1.10
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by karyon):
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
Old description:
> https://docs.djangoproject.com/en/1.10/releases/1.10/#forms says
>
> {{{
> Required form fields now have the required HTML attribute. Set the new
> Form.use_required_attribute attribute to False to disable it. The
> required attribute isn’t included on forms of formsets because the
> browser validation may not be correct when adding and deleting formsets.
> }}}
> i would expect all of that (it's rendered, can be disabled, isn't
> rendered in formsets) to appear somewhere around
> https://docs.djangoproject.com/el/1.10/ref/forms/fields/#required, but it
> does not.
New description:
https://docs.djangoproject.com/en/1.10/releases/1.10/#forms says
{{{
Required form fields now have the required HTML attribute. Set the new
Form.use_required_attribute attribute to False to disable it. The required
attribute isn’t included on forms of formsets because the browser
validation may not be correct when adding and deleting formsets.
}}}
i would expect all of that (it's rendered, can be disabled, isn't rendered
in formsets) to appear somewhere around
https://docs.djangoproject.com/el/1.10/ref/forms/fields/#required, but it
does not.
ref https://code.djangoproject.com/ticket/27299. I guess this per-widget
option should rather not be mentioned in the field documentation...?
--
--
Ticket URL: <https://code.djangoproject.com/ticket/27387#comment:1>
Django
Field.required
--------------------------------------+------------------------------------
Reporter: karyon | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Forms | Version: 1.10
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham):
* stage: Unreviewed => Accepted
Comment:
See ec6121693f112ae33b653b4364e812722d2eb567 for the change and all places
the documentation was updated. I guess it's a matter of judgment how many
times to repeat certain things and to add links as appropriate.
--
Ticket URL: <https://code.djangoproject.com/ticket/27387#comment:2>
Django
Field.required
-------------------------------------+-------------------------------------
Reporter: karyon | Owner: Zbigniew
Type: | Siciarz
Cleanup/optimization | Status: assigned
Component: Forms | Version: 1.10
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Zbigniew Siciarz):
* owner: nobody => Zbigniew Siciarz
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/27387#comment:3>
Django
Field.required
-------------------------------------+-------------------------------------
Reporter: karyon | Owner: Zbigniew
Type: | Siciarz
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Zbigniew Siciarz):
It makes sense to me to add a `versionadded` note and refer to 1.10
release notes for details. I've created a PR here:
https://github.com/django/django/pull/7485
--
Ticket URL: <https://code.djangoproject.com/ticket/27387#comment:4>
Django
Field.required
-------------------------------------+-------------------------------------
Reporter: karyon | Owner: Zbigniew
Type: | Siciarz
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Zbigniew Siciarz):
* has_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/27387#comment:5>
Django
Field.required
-------------------------------------+-------------------------------------
Reporter: karyon | Owner: Zbigniew
Type: | Siciarz
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by mr-bo-jangles):
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/27387#comment:6>
Django
Field.required
-------------------------------------+-------------------------------------
Reporter: karyon | Owner: Zbigniew
Type: | Siciarz
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham):
* needs_better_patch: 0 => 1
* stage: Ready for checkin => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/27387#comment:7>
Django
Field.required
-------------------------------------+-------------------------------------
Reporter: karyon | Owner: Zbigniew
Type: | Siciarz
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Changes (by Tim Graham):
* component: Forms => Documentation
--
Ticket URL: <https://code.djangoproject.com/ticket/27387#comment:8>
Django
Field.required
-------------------------------------+-------------------------------------
Reporter: karyon | Owner: Zbigniew
Type: | Siciarz
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 1.10
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Claude Paroz):
* needs_better_patch: 1 => 0
Comment:
New [https://github.com/django/django/pull/7848 PR].
--
Ticket URL: <https://code.djangoproject.com/ticket/27387#comment:9>
Django
Field.required
-------------------------------------+-------------------------------------
Reporter: karyon | Owner: Zbigniew
Type: | Siciarz
Component: Documentation | Version: 1.10
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"611ef422b173b450b1fc6f7f94eb262961b24e54" 611ef42]:
{{{
#!CommitTicketReference repository=""
revision="611ef422b173b450b1fc6f7f94eb262961b24e54"
Fixed #27387 -- Doc'd required HTML attribute in Field.required docs.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27387#comment:10>
Django
Field.required
-------------------------------------+-------------------------------------
Reporter: karyon | Owner: Zbigniew
Type: | Siciarz
Cleanup/optimization | Status: closed
Component: Documentation | Version: 1.10
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"f3af0acb09219e82ad2d32b16e69ef600abddc07" f3af0acb]:
{{{
#!CommitTicketReference repository=""
revision="f3af0acb09219e82ad2d32b16e69ef600abddc07"
[1.10.x] Fixed #27387 -- Doc'd required HTML attribute in Field.required
docs.
Backport of 611ef422b173b450b1fc6f7f94eb262961b24e54 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/27387#comment:11>