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

…iew. Backport of de4492f from master
django · Feb 8, 2021 · 4f5e550 · 4f5e550
1 parent efaf9f4
commit 4f5e550
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 4 deletions.
diff --git a/docs/ref/class-based-views/generic-date-based.txt b/docs/ref/class-based-views/generic-date-based.txt
@@ -576,7 +576,7 @@ views for displaying drilldown pages for date-based data.
     * :class:`django.views.generic.dates.MonthMixin`
     * :class:`django.views.generic.dates.DayMixin`
     * :class:`django.views.generic.dates.DateMixin`
-    * ``django.views.generic.detail.BaseDetailView``
+    * :class:`django.views.generic.detail.BaseDetailView`
     * :class:`django.views.generic.detail.SingleObjectMixin`
     * :class:`django.views.generic.base.View`
 

diff --git a/docs/ref/class-based-views/generic-display.txt b/docs/ref/class-based-views/generic-display.txt
@@ -19,7 +19,7 @@ many projects they are typically the most commonly used views.
 
     * :class:`django.views.generic.detail.SingleObjectTemplateResponseMixin`
     * :class:`django.views.generic.base.TemplateResponseMixin`
-    * ``django.views.generic.detail.BaseDetailView``
+    * :class:`django.views.generic.detail.BaseDetailView`
     * :class:`django.views.generic.detail.SingleObjectMixin`
     * :class:`django.views.generic.base.View`
 
@@ -73,6 +73,26 @@ many projects they are typically the most commonly used views.
         <p>Published: {{ object.pub_date|date }}</p>
         <p>Date: {{ now|date }}</p>
 
+.. class:: django.views.generic.detail.BaseDetailView
+
+    A base view for displaying a single object. It is not intended to be used
+    directly, but rather as a parent class of the
+    :class:`django.views.generic.detail.DetailView` or other views representing
+    details of a single object.
+
+    **Ancestors (MRO)**
+
+    This view inherits methods and attributes from the following views:
+
+    * :class:`django.views.generic.detail.SingleObjectMixin`
+    * :class:`django.views.generic.base.View`
+
+    **Methods**
+
+    .. method:: get(request, *args, **kwargs)
+
+        Adds ``object`` to the context.
+
 ``ListView``
 ============
 

diff --git a/docs/ref/class-based-views/generic-editing.txt b/docs/ref/class-based-views/generic-editing.txt
@@ -216,7 +216,7 @@ editing content:
     * :class:`django.views.generic.base.TemplateResponseMixin`
     * ``django.views.generic.edit.BaseDeleteView``
     * :class:`django.views.generic.edit.DeletionMixin`
-    * ``django.views.generic.detail.BaseDetailView``
+    * :class:`django.views.generic.detail.BaseDetailView`
     * :class:`django.views.generic.detail.SingleObjectMixin`
     * :class:`django.views.generic.base.View`
 

diff --git a/docs/topics/class-based-views/mixins.txt b/docs/topics/class-based-views/mixins.txt
@@ -636,7 +636,7 @@ To use it, we need to mix it into a ``TemplateView`` for example, and override
 Equally we could use our mixin with one of the generic views. We can make our
 own version of :class:`~django.views.generic.detail.DetailView` by mixing
 ``JSONResponseMixin`` with the
-``django.views.generic.detail.BaseDetailView`` -- (the
+:class:`~django.views.generic.detail.BaseDetailView` -- (the
 :class:`~django.views.generic.detail.DetailView` before template
 rendering behavior has been mixed in)::