summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2016-12-31 08:27:32 -0500
committerTim Graham <timograham@gmail.com>2017-01-17 20:52:01 -0500
commit75cf9b5ac031feb8f94271c9906157c921a14520 (patch)
tree51061671e97c44a71f080329497f5afb49b95585 /docs
parentd67a46e10459858b681176a3e1f8c6bca39d2ac7 (diff)
Refs #13110 -- Removed SyndicationFeed.add_item()'s enclosure argument.
Per deprecation timeline.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/syndication.txt8
-rw-r--r--docs/ref/utils.txt11
-rw-r--r--docs/releases/2.0.txt3
3 files changed, 5 insertions, 17 deletions
diff --git a/docs/ref/contrib/syndication.txt b/docs/ref/contrib/syndication.txt
index 25851c94a3..3552f70f29 100644
--- a/docs/ref/contrib/syndication.txt
+++ b/docs/ref/contrib/syndication.txt
@@ -963,7 +963,6 @@ They share this interface:
* ``pubdate``
* ``comments``
* ``unique_id``
- * ``enclosure``
* ``enclosures``
* ``categories``
* ``item_copyright``
@@ -976,17 +975,10 @@ They share this interface:
* ``pubdate`` should be a Python :class:`~datetime.datetime` object.
* ``updateddate`` should be a Python :class:`~datetime.datetime` object.
- * ``enclosure`` should be an instance of
- :class:`django.utils.feedgenerator.Enclosure`.
* ``enclosures`` should be a list of
:class:`django.utils.feedgenerator.Enclosure` instances.
* ``categories`` should be a sequence of Unicode objects.
- .. deprecated:: 1.9
-
- The ``enclosure`` keyword argument is deprecated in favor of the
- ``enclosures`` keyword argument.
-
:meth:`.SyndicationFeed.write`
Outputs the feed in the given encoding to outfile, which is a file-like object.
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 18561781c1..1105dc9a16 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -353,18 +353,11 @@ https://web.archive.org/web/20110718035220/http://diveintomark.org/archives/2004
All parameters should be Unicode objects, except ``categories``, which
should be a sequence of Unicode objects.
- .. method:: add_item(title, link, description, author_email=None, author_name=None, author_link=None, pubdate=None, comments=None, unique_id=None, enclosure=None, categories=(), item_copyright=None, ttl=None, updateddate=None, enclosures=None, **kwargs)
+ .. method:: add_item(title, link, description, author_email=None, author_name=None, author_link=None, pubdate=None, comments=None, unique_id=None, categories=(), item_copyright=None, ttl=None, updateddate=None, enclosures=None, **kwargs)
Adds an item to the feed. All args are expected to be Python ``unicode``
objects except ``pubdate`` and ``updateddate``, which are ``datetime.datetime``
- objects, ``enclosure``, which is an ``Enclosure`` instance, and
- ``enclosures``, which is a list of ``Enclosure`` instances.
-
- .. deprecated:: 1.9
-
- The ``enclosure`` keyword argument is deprecated in favor of the
- new ``enclosures`` keyword argument which accepts a list of
- ``Enclosure`` objects.
+ objects, and ``enclosures``, which is a list of ``Enclosure`` instances.
.. method:: num_items()
diff --git a/docs/releases/2.0.txt b/docs/releases/2.0.txt
index 311a3d6da4..13a47840c3 100644
--- a/docs/releases/2.0.txt
+++ b/docs/releases/2.0.txt
@@ -312,3 +312,6 @@ these features.
* Support for the ``allow_tags`` attribute on ``ModelAdmin`` methods is
removed.
+
+* The ``enclosure`` keyword argument to ``SyndicationFeed.add_item()`` is
+ removed.