diff options
author | Serhiy Storchaka <storchaka@gmail.com> | 2013-01-13 20:24:27 (GMT) |
---|---|---|
committer | Serhiy Storchaka <storchaka@gmail.com> | 2013-01-13 20:24:27 (GMT) |
commit | 9e189f0a28ed99a29915dda839b913109a178111 (patch) | |
tree | 3471191876df04e838498f52efbc0949e90e5a51 | |
parent | e9af827fb1682a2378d189b4e7cb8ead405a991b (diff) | |
parent | f1b045f41740b1e25ecb5fc4f75003fac59c118a (diff) | |
download | cpython-9e189f0a28ed99a29915dda839b913109a178111.zip cpython-9e189f0a28ed99a29915dda839b913109a178111.tar.gz cpython-9e189f0a28ed99a29915dda839b913109a178111.tar.bz2 |
Cleanup the docs ElementTree a bit.
-rw-r--r-- | Doc/library/xml.etree.elementtree.rst | 12 | ||||
-rw-r--r-- | Lib/xml/etree/ElementTree.py | 16 |
2 files changed, 14 insertions, 14 deletions
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index 88855d9..2a9f9b3 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -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,8 @@ ElementTree Objects section root element. - .. method:: write(file, encoding="us-ascii", xml_declaration=None,\ - default_namespace=None, method="xml", *,\ + .. 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 @@ -761,9 +761,9 @@ ElementTree Objects *xml_declaration* controls if an XML declaration should be added to the file. Use ``False`` for never, ``True`` for always, ``None`` for only if not US-ASCII or UTF-8 or Unicode (default is ``None``). + *default_namespace* sets the default XML namespace (for "xmlns"). *method* is either ``"xml"``, ``"html"`` or ``"text"`` (default is - ``"xml"``). *default_namespace* sets the default XML namespace (for - "xmlns"). + ``"xml"``). 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 diff --git a/Lib/xml/etree/ElementTree.py b/Lib/xml/etree/ElementTree.py index eab0a4f..85cab2b 100644 --- a/Lib/xml/etree/ElementTree.py +++ b/Lib/xml/etree/ElementTree.py @@ -785,16 +785,16 @@ class ElementTree: default_namespace=None, method=None, *, short_empty_elements=True): - """Write the element tree to a file, as XML. 'file_or_filename' is a - file name or a file object opened for writing. 'encoding' is the - output encoding (default is US-ASCII). 'xml_declaration' controls - if an XML declaration should be added to the output. 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" - (default), "html", "text" or "c14n". + """Write the element tree to a file, as XML. 'file_or_filename' is a + file name or a file object opened for writing. + 'encoding' is the output encoding (default is US-ASCII). + 'xml_declaration' controls if an XML declaration should be added + to the output. Use False for never, True for always, None for only + if not US-ASCII or UTF-8 or Unicode (default is None). 'default_namespace' sets the default XML namespace (for "xmlns"). + 'method' is either "xml" (default), "html", "text" or "c14n". The keyword-only 'short_empty_elements' parameter controls the - formatting of elements that contain no content. If True (default), + formatting of elements that contain no content. If True (default), they are emitted as a single self-closed tag, otherwise they are emitted as a pair of start/end tags. |