mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-03 03:22:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Cleanup the docs ElementTree a bit and describe the default_namespace parameter. In the code, replace the old outdated Doxygen-ish comment above ElementTree.write by a proper docstring.

Browse source
This commit is contained in:
Eli Bendersky 2013-01-13 06:27:51 -08:00
parent 31efc746d5
commit e9af827fb1
2 changed files with 21 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/library/xml.etree.elementtree.rst
View file

@ -428,7 +428,7 @@ Functions
arguments. Returns an element instance.
.. function:: tostring(element, encoding="us-ascii", method="xml", *, \
.. function:: tostring(element, encoding="us-ascii", method="xml", *,\
short_empty_elements=True)
Generates a string representation of an XML element, including all
@ -443,7 +443,7 @@ Functions
The *short_empty_elements* parameter.
.. function:: tostringlist(element, encoding="us-ascii", method="xml", *, \
.. function:: tostringlist(element, encoding="us-ascii", method="xml", *,\
short_empty_elements=True)
Generates a string representation of an XML element, including all
@ -751,8 +751,9 @@ ElementTree Objects
section root element.
.. method:: write(file, encoding="us-ascii", xml_declaration=None, \
method="xml", *, short_empty_elements=True)
.. method:: write(file, encoding="us-ascii", xml_declaration=None,\
default_namespace=None, method="xml", *,\
short_empty_elements=True)
Writes the element tree to a file, as XML. *file* is a file name, or a
:term:`file object` opened for writing. *encoding* [1]_ is the output
@ -761,7 +762,8 @@ ElementTree Objects
file. Use ``False`` for never, ``True`` for always, ``None``
for only if not US-ASCII or UTF-8 or Unicode (default is ``None``).
*method* is either ``"xml"``, ``"html"`` or ``"text"`` (default is
``"xml"``).
``"xml"``). *default_namespace* sets the default XML namespace (for
"xmlns").
The keyword-only *short_empty_elements* parameter controls the formatting
of elements that contain no content. If *True* (the default), they are
emitted as a single self-closed tag, otherwise they are emitted as a pair