diff options
| author | Lance Stout <lancestout@gmail.com> | 2011-11-22 16:25:33 -0800 |
|---|---|---|
| committer | Lance Stout <lancestout@gmail.com> | 2011-11-22 16:25:33 -0800 |
| commit | b87c4d786d1c093af3368b8bcfb9c3754fc1ba7a (patch) | |
| tree | 435e41e36c61c77c1118996b6eaba17e22f12f37 /sleekxmpp/xmlstream/tostring.py | |
| parent | 329b0df3f6e5649fde4716ad3acc661bdd3b4901 (diff) | |
| download | slixmpp-b87c4d786d1c093af3368b8bcfb9c3754fc1ba7a.tar.gz slixmpp-b87c4d786d1c093af3368b8bcfb9c3754fc1ba7a.tar.bz2 slixmpp-b87c4d786d1c093af3368b8bcfb9c3754fc1ba7a.tar.xz slixmpp-b87c4d786d1c093af3368b8bcfb9c3754fc1ba7a.zip | |
Update tostring docs, plus more doc cleanup
Diffstat (limited to 'sleekxmpp/xmlstream/tostring.py')
| -rw-r--r-- | sleekxmpp/xmlstream/tostring.py | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/sleekxmpp/xmlstream/tostring.py b/sleekxmpp/xmlstream/tostring.py index ed58049e..8e729f79 100644 --- a/sleekxmpp/xmlstream/tostring.py +++ b/sleekxmpp/xmlstream/tostring.py @@ -27,9 +27,7 @@ def tostring(xml=None, xmlns='', stanza_ns='', stream=None, elements that use those namespaces will not include the xmlns attribute in the output. - :param XML xml: The XML object to serialize. If the value is ``None``, - then the XML object contained in this stanza - object will be used. + :param XML xml: The XML object to serialize. :param string xmlns: Optional namespace of an element wrapping the XML object. :param string stanza_ns: The namespace of the stanza object that contains @@ -40,6 +38,8 @@ def tostring(xml=None, xmlns='', stanza_ns='', stream=None, :param bool top_level: Indicates that the element is the outermost element. + + :type xml: :py:class:`~xml.etree.ElementTree.Element` :type stream: :class:`~sleekxmpp.xmlstream.xmlstream.XMLStream` :rtype: Unicode string @@ -114,6 +114,7 @@ def xml_escape(text): """Convert special characters in XML to escape sequences. :param string text: The XML text to convert. + :rtype: Unicode string """ if sys.version_info < (3, 0): if type(text) != types.UnicodeType: |