Thelie/python-feedgen
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Added note about *_str return type

Browse source 
Signed-off-by: Lars Kiesow <lkiesow@uos.de>
This commit is contained in:
Lars Kiesow 2016-09-04 19:52:55 +02:00
parent b4400146ea
commit 2d605c303b
No known key found for this signature in database
GPG key ID: 5DAFE8D9C823CE73
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
feedgen/feed.py
View file

@ -211,6 +211,11 @@ class FeedGenerator(object):
:param xml_declaration: If an XML declaration should be added to the
output (Default: enabled).
:returns: String representation of the ATOM feed.
**Return type:** The return type may vary between different Python
versions and your encoding parameters passed to this method. For details
have a look at the `lxml documentation
<https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring>`_
'''
feed, doc = self._create_atom(extensions=extensions)
return etree.tostring(feed, pretty_print=pretty, encoding=encoding,
@ -383,6 +388,11 @@ class FeedGenerator(object):
:param xml_declaration: If an XML declaration should be added to the
output (Default: enabled).
:returns: String representation of the RSS feed.
**Return type:** The return type may vary between different Python
versions and your encoding parameters passed to this method. For details
have a look at the `lxml documentation
<https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring>`_
'''
feed, doc = self._create_rss(extensions=extensions)
return etree.tostring(feed, pretty_print=pretty, encoding=encoding,