Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#32536 closed Cleanup/optimization (fixed)

Add references to get() methods in CBV docs.

Reported by: Thomas Güttler Owned by: Hasan Ramezani
Component: Documentation Version: 3.1
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

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.

Change History (8)

comment:1 by Mariusz Felisiak, 4 years ago

Easy pickings: set
Summary: CBV FllowChart missing a hyperlink for "get()"Add references to get() methods in CBV docs.
Triage Stage: UnreviewedAccepted
Type: BugCleanup/optimization

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.

comment:2 by Carlton Gibson, 4 years ago

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

comment:3 by Mariusz Felisiak, 4 years ago

We should also add a reference to the DetailView.get() in Class-based generic views - flattened index docs.

comment:4 by Hasan Ramezani, 4 years ago

Has patch: set
Owner: changed from nobody to Hasan Ramezani
Status: newassigned

comment:5 by Mariusz Felisiak, 4 years ago

Triage Stage: AcceptedReady for checkin

comment:6 by Mariusz Felisiak <felisiak.mariusz@…>, 4 years ago

Resolution: fixed
Status: assignedclosed

In bc04941b:

Fixed #32536 -- Added links to BaseDetailView/BaseListView.get() methods in CBV docs.

comment:7 by Mariusz Felisiak <felisiak.mariusz@…>, 4 years ago

In 7e43a100:

[3.2.x] Fixed #32536 -- Added links to BaseDetailView/BaseListView.get() methods in CBV docs.

Backport of bc04941bf811d1ea2c79fb7fc20457ed2c7e3410 from main

comment:8 by Mariusz Felisiak <felisiak.mariusz@…>, 4 years ago

In 0415ac5:

[3.1.x] Fixed #32536 -- Added links to BaseDetailView/BaseListView.get() methods in CBV docs.

Backport of bc04941bf811d1ea2c79fb7fc20457ed2c7e3410 from main

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