#32408 closed Cleanup/optimization (fixed)
Missing documentation for django.views.generic.detail.BaseDetailView
| Reported by: | johnthagen | Owned by: | Anil Khatri |
|---|---|---|---|
| Component: | Documentation | Version: | 3.1 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
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
Change History (6)
comment:1 by , 3 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|---|
| Type: | Uncategorized → Cleanup/optimization |
comment:2 by , 3 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
Note:
See TracTickets
for help on using tickets.
Yes, OK, seems reasonable.
A nested definition at the bottom of the
DetailViewsection 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