Visitar URL original
[3.1.x] Fixed #32408 -- Doc'd django.views.generic.detail.BaseDetailV… · django/django@4f5e550 · GitHub
Skip to content

Commit 4f5e550

Browse files
imkakafelixxm
authored andcommitted
[3.1.x] Fixed #32408 -- Doc'd django.views.generic.detail.BaseDetailView.
Backport of de4492f from master
1 parent efaf9f4 commit 4f5e550

4 files changed

Lines changed: 24 additions & 4 deletions

File tree

‎docs/ref/class-based-views/generic-date-based.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ views for displaying drilldown pages for date-based data.
576576
* :class:`django.views.generic.dates.MonthMixin`
577577
* :class:`django.views.generic.dates.DayMixin`
578578
* :class:`django.views.generic.dates.DateMixin`
579-
* ``django.views.generic.detail.BaseDetailView``
579+
* :class:`django.views.generic.detail.BaseDetailView`
580580
* :class:`django.views.generic.detail.SingleObjectMixin`
581581
* :class:`django.views.generic.base.View`
582582

‎docs/ref/class-based-views/generic-display.txt‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ many projects they are typically the most commonly used views.
1919

2020
* :class:`django.views.generic.detail.SingleObjectTemplateResponseMixin`
2121
* :class:`django.views.generic.base.TemplateResponseMixin`
22-
* ``django.views.generic.detail.BaseDetailView``
22+
* :class:`django.views.generic.detail.BaseDetailView`
2323
* :class:`django.views.generic.detail.SingleObjectMixin`
2424
* :class:`django.views.generic.base.View`
2525

@@ -73,6 +73,26 @@ many projects they are typically the most commonly used views.
7373
<p>Published: {{ object.pub_date|date }}</p>
7474
<p>Date: {{ now|date }}</p>
7575

76+
.. class:: django.views.generic.detail.BaseDetailView
77+
78+
A base view for displaying a single object. It is not intended to be used
79+
directly, but rather as a parent class of the
80+
:class:`django.views.generic.detail.DetailView` or other views representing
81+
details of a single object.
82+
83+
**Ancestors (MRO)**
84+
85+
This view inherits methods and attributes from the following views:
86+
87+
* :class:`django.views.generic.detail.SingleObjectMixin`
88+
* :class:`django.views.generic.base.View`
89+
90+
**Methods**
91+
92+
.. method:: get(request, *args, **kwargs)
93+
94+
Adds ``object`` to the context.
95+
7696
``ListView``
7797
============
7898

‎docs/ref/class-based-views/generic-editing.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ editing content:
216216
* :class:`django.views.generic.base.TemplateResponseMixin`
217217
* ``django.views.generic.edit.BaseDeleteView``
218218
* :class:`django.views.generic.edit.DeletionMixin`
219-
* ``django.views.generic.detail.BaseDetailView``
219+
* :class:`django.views.generic.detail.BaseDetailView`
220220
* :class:`django.views.generic.detail.SingleObjectMixin`
221221
* :class:`django.views.generic.base.View`
222222

‎docs/topics/class-based-views/mixins.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -636,7 +636,7 @@ To use it, we need to mix it into a ``TemplateView`` for example, and override
636636
Equally we could use our mixin with one of the generic views. We can make our
637637
own version of :class:`~django.views.generic.detail.DetailView` by mixing
638638
``JSONResponseMixin`` with the
639-
``django.views.generic.detail.BaseDetailView`` -- (the
639+
:class:`~django.views.generic.detail.BaseDetailView` -- (the
640640
:class:`~django.views.generic.detail.DetailView` before template
641641
rendering behavior has been mixed in)::
642642

0 commit comments

Comments
 (0)