From a0c67c69bf49d9e1902afd57d95b8511aa911ccb Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 1 Feb 2013 13:42:30 +0100 Subject: [PATCH] Documented ArchiveIndexView's date_list context variable. Refs #16218. --- .../class-based-views/generic-date-based.txt | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/ref/class-based-views/generic-date-based.txt b/docs/ref/class-based-views/generic-date-based.txt index 42dbab4dd8..4144c382f8 100644 --- a/docs/ref/class-based-views/generic-date-based.txt +++ b/docs/ref/class-based-views/generic-date-based.txt @@ -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` object + containing all years that have objects available according to + ``queryset``, represented as + :class:`datetime.datetime` objects, in + descending order. + **Notes** * Uses a default ``context_object_name`` of ``latest``. @@ -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 @@ -118,7 +131,7 @@ YearArchiveView context will be: * ``date_list``: A - :meth:`DateQuerySet` object object + :meth:`DateQuerySet` object containing all months that have objects available according to ``queryset``, represented as :class:`datetime.datetime` objects, in