Browse Source

Fixed #24985 -- Added note about possible invalid feed content

Thanks Michael Wood for the report and Tim Graham for the review.
Claude Paroz 9 years ago
parent
commit
1c90a3dcca
1 changed files with 4 additions and 1 deletions
  1. 4 1
      docs/ref/contrib/syndication.txt

+ 4 - 1
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.