diff options
| author | Alexey Opalev <levisolympus@gmail.com> | 2017-02-15 14:36:18 +0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2017-02-28 11:48:07 -0500 |
| commit | 9f21e35100b022b31fe723323db85c2cb28b16b8 (patch) | |
| tree | 337c522db02a3215797d394d01668e6d641d12d6 /docs/ref | |
| parent | 81957086c187929a2a3de495087dcaef7bb339df (diff) | |
Fixed #27842 -- Added protocol kwarg to GenericSitemap.__init__().
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/contrib/sitemaps.txt | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/ref/contrib/sitemaps.txt b/docs/ref/contrib/sitemaps.txt index fb3871e58e..aebf62ac53 100644 --- a/docs/ref/contrib/sitemaps.txt +++ b/docs/ref/contrib/sitemaps.txt @@ -259,7 +259,7 @@ Shortcuts The sitemap framework provides a convenience class for a common case: -.. class:: GenericSitemap +.. class:: GenericSitemap(info_dict, priority=None, changefreq=None, protocol=None) The :class:`django.contrib.sitemaps.GenericSitemap` class allows you to create a sitemap by passing it a dictionary which has to contain at least @@ -267,10 +267,15 @@ The sitemap framework provides a convenience class for a common case: of the sitemap. It may also have a ``date_field`` entry that specifies a date field for objects retrieved from the ``queryset``. This will be used for the :attr:`~Sitemap.lastmod` attribute in the - generated sitemap. You may also pass :attr:`~Sitemap.priority` and - :attr:`~Sitemap.changefreq` keyword arguments to the - :class:`~django.contrib.sitemaps.GenericSitemap` constructor to specify - these attributes for all URLs. + generated sitemap. + + The :attr:`~Sitemap.priority`, :attr:`~Sitemap.changefreq`, + and :attr:`~Sitemap.protocol` keyword arguments allow specifying these + attributes for all URLs. + + .. versionadded:: 2.0 + + The ``protocol`` keyword argument was added. Example ------- |