Skip to content

Commit

Permalink
Documented ArchiveIndexView's date_list context variable.
Browse files Browse the repository at this point in the history
Refs #16218.
  • Loading branch information
aaugustin committed Feb 1, 2013
1 parent 393c268 commit a0c67c6
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions docs/ref/class-based-views/generic-date-based.txt
Expand Up @@ -42,6 +42,20 @@ ArchiveIndexView
* :class:`django.views.generic.dates.DateMixin`
* :class:`django.views.generic.base.View`

**Context**

In addition to the context provided by
:class:`django.views.generic.list.MultipleObjectMixin` (via
:class:`django.views.generic.dates.BaseDateListView`), the template's
context will be:

* ``date_list``: A
:meth:`DateQuerySet<django.db.models.query.QuerySet.dates>` object
containing all years that have objects available according to
``queryset``, represented as
:class:`datetime.datetime<python:datetime.datetime>` objects, in
descending order.

**Notes**

* Uses a default ``context_object_name`` of ``latest``.
Expand Down Expand Up @@ -109,7 +123,6 @@ YearArchiveView
Determine if an object list will be returned as part of the context.
Returns :attr:`~YearArchiveView.make_object_list` by default.


**Context**

In addition to the context provided by
Expand All @@ -118,7 +131,7 @@ YearArchiveView
context will be:

* ``date_list``: A
:meth:`DateQuerySet<django.db.models.query.QuerySet.dates>` object object
:meth:`DateQuerySet<django.db.models.query.QuerySet.dates>` object
containing all months that have objects available according to
``queryset``, represented as
:class:`datetime.datetime<python:datetime.datetime>` objects, in
Expand Down

0 comments on commit a0c67c6

Please sign in to comment.