[Django] #32536: CBV FllowChart missing a hyperlink for "get()"

28 views
Skip to first unread message

Django

unread,
Mar 11, 2021, 3:04:41 AM3/11/21
to django-...@googlegroups.com
#32536: CBV FllowChart missing a hyperlink for "get()"
------------------------------------------+------------------------
Reporter: Thomas Güttler | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 3.1
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 |
------------------------------------------+------------------------
thank you very much for the flow chart on this page:
https://docs.djangoproject.com/en/dev/ref/class-based-views/generic-
display/

But why is point #10 "get()" not a hyperlink? Is there no documentation
for this method?

BTW: the flow chart is twice on the page, and the lower has no hyperlink
for get(), too.

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

Django

unread,
Mar 11, 2021, 3:30:09 AM3/11/21
to django-...@googlegroups.com
#32536: Add references to get() methods in CBV docs.
--------------------------------------+------------------------------------

Reporter: Thomas Güttler | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 3.1
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: Bug => Cleanup/optimization
* easy: 0 => 1
* stage: Unreviewed => Accepted


Comment:

> But why is point #10 "get()" not a hyperlink? Is there no documentation
for this method?

We missed this in #32408.

> BTW: the flow chart is twice on the page, and the lower has no hyperlink
for get(), too.

Yes we can add a link here as well.

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

Django

unread,
Mar 11, 2021, 3:34:47 AM3/11/21
to django-...@googlegroups.com
#32536: Add references to get() methods in CBV docs.
--------------------------------------+------------------------------------
Reporter: Thomas Güttler | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 3.1

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
--------------------------------------+------------------------------------

Comment (by Carlton Gibson):

Also though the `get()` methods for the list and detail views on this page
are defined on the very classes we're looking at. They're documented
immediately below, so we'd be linking to the same place (possibly small
viewport shift due to the anchor...)

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

Django

unread,
Mar 11, 2021, 3:37:55 AM3/11/21
to django-...@googlegroups.com
#32536: Add references to get() methods in CBV docs.
--------------------------------------+------------------------------------
Reporter: Thomas Güttler | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 3.1

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
--------------------------------------+------------------------------------

Comment (by Mariusz Felisiak):

We should also add a reference to the `DetailView.get()` in
[https://docs.djangoproject.com/en/dev/ref/class-based-views/flattened-
index/#DetailView "Class-based generic views - flattened index"] docs.

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

Django

unread,
Mar 15, 2021, 9:34:38 AM3/15/21
to django-...@googlegroups.com
#32536: Add references to get() methods in CBV docs.
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 3.1

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 Hasan Ramezani):

* owner: nobody => Hasan Ramezani
* status: new => assigned
* has_patch: 0 => 1


Comment:

[https://github.com/django/django/pull/14129 PR]

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

Django

unread,
Mar 15, 2021, 5:13:38 PM3/15/21
to django-...@googlegroups.com
#32536: Add references to get() methods in CBV docs.
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 3.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

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

* stage: Accepted => Ready for checkin


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

Django

unread,
Mar 16, 2021, 2:58:39 AM3/16/21
to django-...@googlegroups.com
#32536: Add references to get() methods in CBV docs.
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: closed
Component: Documentation | Version: 3.1
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):

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


Comment:

In [changeset:"bc04941bf811d1ea2c79fb7fc20457ed2c7e3410" bc04941b]:
{{{
#!CommitTicketReference repository=""
revision="bc04941bf811d1ea2c79fb7fc20457ed2c7e3410"
Fixed #32536 -- Added links to BaseDetailView/BaseListView.get() methods
in CBV docs.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32536#comment:6>

Django

unread,
Mar 16, 2021, 3:00:16 AM3/16/21
to django-...@googlegroups.com
#32536: Add references to get() methods in CBV docs.
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: closed
Component: Documentation | Version: 3.1

Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"7e43a1008496ba00b584594f99f2ce35347e4d5e" 7e43a100]:
{{{
#!CommitTicketReference repository=""
revision="7e43a1008496ba00b584594f99f2ce35347e4d5e"
[3.2.x] Fixed #32536 -- Added links to BaseDetailView/BaseListView.get()
methods in CBV docs.

Backport of bc04941bf811d1ea2c79fb7fc20457ed2c7e3410 from main
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32536#comment:7>

Django

unread,
Mar 16, 2021, 3:06:22 AM3/16/21
to django-...@googlegroups.com
#32536: Add references to get() methods in CBV docs.
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner: Hasan
Type: | Ramezani
Cleanup/optimization | Status: closed
Component: Documentation | Version: 3.1

Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"0415ac5af97e51aeb77b6b4203e57456535a2c16" 0415ac5]:
{{{
#!CommitTicketReference repository=""
revision="0415ac5af97e51aeb77b6b4203e57456535a2c16"
[3.1.x] Fixed #32536 -- Added links to BaseDetailView/BaseListView.get()
methods in CBV docs.

Backport of bc04941bf811d1ea2c79fb7fc20457ed2c7e3410 from main
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32536#comment:8>

Reply all
Reply to author
Forward
0 new messages