document changes for YearArchiveView.

This commit is contained in:
Collin Anderson 2012-09-18 10:56:39 -04:00
parent 70248cce0a
commit b771bcc7b4
1 changed files with 8 additions and 0 deletions

View File

@ -87,16 +87,24 @@ YearArchiveView
* ``year``: A :class:`~datetime.date` object * ``year``: A :class:`~datetime.date` object
representing the given year. representing the given year.
.. versionchanged:: 1.5
Previously, this returned a string.
* ``next_year``: A :class:`~datetime.date` object * ``next_year``: A :class:`~datetime.date` object
representing the first day of the next year, according to representing the first day of the next year, according to
:attr:`~BaseDateListView.allow_empty` and :attr:`~BaseDateListView.allow_empty` and
:attr:`~DateMixin.allow_future`. :attr:`~DateMixin.allow_future`.
.. versionadded:: 1.5
* ``previous_year``: A :class:`~datetime.date` object * ``previous_year``: A :class:`~datetime.date` object
representing the first day of the previous year, according to representing the first day of the previous year, according to
:attr:`~BaseDateListView.allow_empty` and :attr:`~BaseDateListView.allow_empty` and
:attr:`~DateMixin.allow_future`. :attr:`~DateMixin.allow_future`.
.. versionadded:: 1.5
**Notes** **Notes**
* Uses a default ``template_name_suffix`` of ``_archive_year``. * Uses a default ``template_name_suffix`` of ``_archive_year``.