[Django] #34616: Incorrect code example in 5.0 release notes

10 views
Skip to first unread message

Django

unread,
Jun 1, 2023, 1:27:49 AM6/1/23
to django-...@googlegroups.com
#34616: Incorrect code example in 5.0 release notes
-----------------------------------------+------------------------
Reporter: David Smith | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: 4.2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------
The 5.0 release notes have a code example of a form and its fields being
written in Django Template Language.

However the example shows `field.label` being used. This would give the
field's label this world be "name", in the line linked below.

Instead I believe this example should use `field.label_tag` which would
give ` <label ...>name:</label>`. This is closer to what the template is
actually doing.

https://github.com/django/django/blob/main/docs/releases/5.0.txt#L62

https://github.com/django/django/blob/main/django/forms/templates/django/forms/field.html#L5

--
Ticket URL: <https://code.djangoproject.com/ticket/34616>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Jun 1, 2023, 5:22:38 AM6/1/23
to django-...@googlegroups.com
#34616: Incorrect code example in 5.0 release notes
-------------------------------+------------------------------------

Reporter: David Smith | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+------------------------------------
Changes (by Mariusz Felisiak):

* type: Uncategorized => Bug
* component: Uncategorized => Documentation
* easy: 0 => 1
* stage: Unreviewed => Accepted


--
Ticket URL: <https://code.djangoproject.com/ticket/34616#comment:1>

Django

unread,
Jun 1, 2023, 5:26:14 AM6/1/23
to django-...@googlegroups.com
#34616: Incorrect code example in 5.0 release notes
-------------------------------+------------------------------------------
Reporter: David Smith | Owner: Michael Howitz
Type: Bug | Status: assigned

Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+------------------------------------------
Changes (by Michael Howitz):

* owner: nobody => Michael Howitz
* status: new => assigned


--
Ticket URL: <https://code.djangoproject.com/ticket/34616#comment:2>

Django

unread,
Jun 1, 2023, 5:53:50 AM6/1/23
to django-...@googlegroups.com
#34616: Incorrect code example in 5.0 release notes
-------------------------------------+-------------------------------------

Reporter: David Smith | Owner: Michael
Type: | Howitz
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):

* version: 4.2 => dev
* type: Bug => Cleanup/optimization


--
Ticket URL: <https://code.djangoproject.com/ticket/34616#comment:3>

Django

unread,
Jun 1, 2023, 6:09:16 AM6/1/23
to django-...@googlegroups.com
#34616: Incorrect code example in 5.0 release notes
-------------------------------------+-------------------------------------
Reporter: David Smith | Owner:
Type: | Christopher Cave-Ayland

Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Christopher Cave-Ayland):

* owner: Michael Howitz => Christopher Cave-Ayland
* has_patch: 0 => 1


Comment:

https://github.com/django/django/pull/16912

--
Ticket URL: <https://code.djangoproject.com/ticket/34616#comment:4>

Django

unread,
Jun 1, 2023, 6:19:25 AM6/1/23
to django-...@googlegroups.com
#34616: Incorrect code example in 5.0 release notes
--------------------------------------+------------------------------------
Reporter: David Smith | Owner: cc-a
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by GitHub <noreply@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"24d56e21c3ce8ec9392e8fecc462426e9ed92bbe" 24d56e21]:
{{{
#!CommitTicketReference repository=""
revision="24d56e21c3ce8ec9392e8fecc462426e9ed92bbe"
Fixed #34616 -- Corrected label examples in 5.0 release notes.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/34616#comment:5>

Reply all
Reply to author
Forward
0 new messages