Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#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:

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 Carlton Gibson, 4 years ago

Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization

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

comment:2 by Anil Khatri, 4 years ago

Owner: changed from nobody to Anil Khatri
Status: newassigned

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

Resolution: fixed
Status: assignedclosed

In de4492fb:

Fixed #32408 -- Doc'd django.views.generic.detail.BaseDetailView.

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

Resolution: fixed
Status: assignedclosed

In 20e0e47f:

[3.2.x] Fixed #32408 -- Doc'd django.views.generic.detail.BaseDetailView.

Backport of de4492fbb1e48f8b258baa182220d4247f345177 from master

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

In 4f5e550c:

[3.1.x] Fixed #32408 -- Doc'd django.views.generic.detail.BaseDetailView.

Backport of de4492fbb1e48f8b258baa182220d4247f345177 from master

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