Commit dddd5e90 authored by Florent Xicluna's avatar Florent Xicluna

Merged revisions 78944 via svnmerge from

svn+ssh://pythondev@svn.python.org/python/trunk

........
  r78944 | florent.xicluna | 2010-03-14 02:22:09 +0100 (dim, 14 mar 2010) | 2 lines

  Minor documentation updates for xml.etree.
........
parent 37f31521
...@@ -69,8 +69,8 @@ Functions ...@@ -69,8 +69,8 @@ Functions
.. function:: fromstring(text) .. function:: fromstring(text)
Parses an XML section from a string constant. Same as XML. *text* is a Parses an XML section from a string constant. Same as :func:`XML`. *text*
string containing XML data. Returns an :class:`Element` instance. is a string containing XML data. Returns an :class:`Element` instance.
.. function:: fromstringlist(sequence, parser=None) .. function:: fromstringlist(sequence, parser=None)
...@@ -148,22 +148,24 @@ Functions ...@@ -148,22 +148,24 @@ Functions
arguments. Returns an element instance. arguments. Returns an element instance.
.. function:: tostring(element, encoding=None, method=None) .. function:: tostring(element, encoding=None, method="xml")
Generates a string representation of an XML element, including all Generates a string representation of an XML element, including all
subelements. *element* is an :class:`Element` instance. *encoding* is the subelements. *element* is an :class:`Element` instance. *encoding* [1]_ is
output encoding (default is None). *method* is either ``"xml"``, the output encoding (default is None). *method* is either ``"xml"``,
``"html"`` or ``"text"`` (default is ``"xml"``). Returns an (optionally) ``"html"`` or ``"text"`` (default is ``"xml"``). Returns an (optionally)
encoded string containing the XML data. encoded string containing the XML data.
.. function:: tostringlist(element, encoding=None, method=None) .. function:: tostringlist(element, encoding=None, method="xml")
Generates a string representation of an XML element, including all Generates a string representation of an XML element, including all
subelements. *element* is an :class:`Element` instance. *encoding* is the subelements. *element* is an :class:`Element` instance. *encoding* [1]_ is
output encoding (default is None). *method* is either ``"xml"``, the output encoding (default is None). *method* is either ``"xml"``,
``"html"`` or ``"text"`` (default is ``"xml"``). Returns a sequence object ``"html"`` or ``"text"`` (default is ``"xml"``). Returns a list of
containing the XML data. (optionally) encoded strings containing the XML data. It does not guarantee
any specific sequence, except that ``"".join(tostringlist(element)) ==
tostring(element)``.
.. versionadded:: 2.7 .. versionadded:: 2.7
...@@ -455,7 +457,7 @@ ElementTree Objects ...@@ -455,7 +457,7 @@ ElementTree Objects
root element. root element.
.. method:: write(file, encoding=None, xml_declaration=None, method=None) .. method:: write(file, encoding=None, xml_declaration=None, method="xml")
Writes the element tree to a file, as XML. *file* is a file name, or a Writes the element tree to a file, as XML. *file* is a file name, or a
file object opened for writing. *encoding* [1]_ is the output encoding file object opened for writing. *encoding* [1]_ is the output encoding
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment