summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClaude Paroz <claude@2xlibre.net>2015-06-21 20:53:01 +0200
committerClaude Paroz <claude@2xlibre.net>2015-06-21 20:53:01 +0200
commit1c90a3dccadc7d2da3704ff17ac9ff1a67743934 (patch)
tree3beac8cd4603f8c0fc936612ecab25cd0c26afaa
parent4a6656488893b6a832726cade2d2c5aa04f85ae2 (diff)
Fixed #24985 -- Added note about possible invalid feed content
Thanks Michael Wood for the report and Tim Graham for the review.
-rw-r--r--docs/ref/contrib/syndication.txt5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/ref/contrib/syndication.txt b/docs/ref/contrib/syndication.txt
index 6c86be0d5b..8da4073b97 100644
--- a/docs/ref/contrib/syndication.txt
+++ b/docs/ref/contrib/syndication.txt
@@ -919,7 +919,10 @@ They share this interface:
``self.feed`` for use with `custom feed generators`_.
All parameters should be Unicode objects, except ``categories``, which
- should be a sequence of Unicode objects.
+ should be a sequence of Unicode objects. Beware that some control characters
+ are `not allowed <http://www.w3.org/International/questions/qa-controls>`_
+ in XML documents. If your content has some of them, you might encounter a
+ :exc:`ValueError` when producing the feed.
:meth:`.SyndicationFeed.add_item`
Add an item to the feed with the given parameters.