[Django] #32408: Missing documentation for django.views.generic.detail.BaseDetailView
Django
-----------------------------------------+------------------------
Reporter: johnthagen | Owner: nobody
Type: Uncategorized | 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 |
-----------------------------------------+------------------------
Several places in the docs, `django.views.generic.detail.BaseDetailView`
is referenced, but it does not have hyperlinked documentation:
- https://docs.djangoproject.com/en/dev/ref/class-based-views/generic-
display/#detailview
- https://docs.djangoproject.com/en/dev/topics/class-based-views/mixins
/#more-than-just-html
I discovered this when I was trying to add a documentation link to it from
`django-downloadview`: https://django-
downloadview.readthedocs.io/en/latest/views/object.html#simple-example
--
Ticket URL: <https://code.djangoproject.com/ticket/32408>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: johnthagen | 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: 0 | UI/UX: 0
Changes (by Carlton Gibson):
* type: Uncategorized => Cleanup/optimization
* stage: Unreviewed => Accepted
Comment:
Yes, OK, seems reasonable.
A nested definition at the bottom of the `DetailView` section would be
perfect. (Plus adding crosslinks where appropriate.)
See the same for BaseListView lower down the page:
https://docs.djangoproject.com/en/dev/ref/class-based-views/generic-
display/#django.views.generic.list.BaseListView
> A base view for displaying a list of objects. It is not intended to be
used directly, but rather as a parent class of ...
--
Ticket URL: <https://code.djangoproject.com/ticket/32408#comment:1>
Django
Reporter: johnthagen | Owner: Anil
Type: | Khatri
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 3.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Anil Khatri):
* owner: nobody => Anil Khatri
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/32408#comment:2>
Django
Reporter: johnthagen | Owner: Anil
Type: | Khatri
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 Anil Khatri):
* has_patch: 0 => 1
Comment:
https://github.com/django/django/pull/13968
--
Ticket URL: <https://code.djangoproject.com/ticket/32408#comment:3>
Django
Reporter: johnthagen | Owner: Anil
Type: | Khatri
Component: Documentation | Version: 3.1
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"de4492fbb1e48f8b258baa182220d4247f345177" de4492fb]:
{{{
#!CommitTicketReference repository=""
revision="de4492fbb1e48f8b258baa182220d4247f345177"
Fixed #32408 -- Doc'd django.views.generic.detail.BaseDetailView.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32408#comment:4>
Django
Reporter: johnthagen | Owner: Anil
Type: | Khatri
Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"20e0e47f252ad97568efefe25e2442b42fd96713" 20e0e47f]:
{{{
#!CommitTicketReference repository=""
revision="20e0e47f252ad97568efefe25e2442b42fd96713"
[3.2.x] Fixed #32408 -- Doc'd django.views.generic.detail.BaseDetailView.
Backport of de4492fbb1e48f8b258baa182220d4247f345177 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32408#comment:5>
Django
Reporter: johnthagen | Owner: Anil
Type: | Khatri
Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"4f5e550cda931581000f1108c7edc39476ce44be" 4f5e550c]:
{{{
#!CommitTicketReference repository=""
revision="4f5e550cda931581000f1108c7edc39476ce44be"
[3.1.x] Fixed #32408 -- Doc'd django.views.generic.detail.BaseDetailView.
Backport of de4492fbb1e48f8b258baa182220d4247f345177 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/32408#comment:6>