p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed #30817 -- Clarified return value of Sitemap.items().

This commit is contained in:
Sjbrgsn 2019-09-30 14:52:17 +02:00 committed by Mariusz Felisiak
parent 8ed6788aa4
commit 7b3c06cd72
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/ref/contrib/sitemaps.txt
View File

@ -116,10 +116,11 @@ Note:
attributes corresponding to ``<changefreq>`` and ``<priority>`` elements,
respectively. They can be made callable as functions, as
:attr:`~Sitemap.lastmod` was in the example.
* :attr:`~Sitemap.items()` is a method that returns a list of objects. The
objects returned will get passed to any callable methods corresponding to a
sitemap property (:attr:`~Sitemap.location`, :attr:`~Sitemap.lastmod`,
:attr:`~Sitemap.changefreq`, and :attr:`~Sitemap.priority`).
* :attr:`~Sitemap.items()` is a method that returns a :term:`sequence` or
``QuerySet`` of objects. The objects returned will get passed to any callable
methods corresponding to a sitemap property (:attr:`~Sitemap.location`,
:attr:`~Sitemap.lastmod`, :attr:`~Sitemap.changefreq`, and
:attr:`~Sitemap.priority`).
* :attr:`~Sitemap.lastmod` should return a :class:`~datetime.datetime`.
* There is no :attr:`~Sitemap.location` method in this example, but you
can provide it in order to specify the URL for your object. By default,
@ -135,11 +136,11 @@ Note:
.. attribute:: Sitemap.items
**Required.** A method that returns a list of objects. The framework
doesn't care what *type* of objects they are; all that matters is that
these objects get passed to the :attr:`~Sitemap.location()`,
:attr:`~Sitemap.lastmod()`, :attr:`~Sitemap.changefreq()` and
:attr:`~Sitemap.priority()` methods.
**Required.** A method that returns a :term:`sequence` or ``QuerySet``
of objects. The framework doesn't care what *type* of objects they are;
all that matters is that these objects get passed to the
:attr:`~Sitemap.location()`, :attr:`~Sitemap.lastmod()`,
:attr:`~Sitemap.changefreq()` and :attr:`~Sitemap.priority()` methods.
.. attribute:: Sitemap.location