[Python-checkins] r74077 - python/trunk/Doc/library/xml.etree.elementtree.rst
georg.brandl
python-checkins at python.org
Sat Jul 18 11:43:40 CEST 2009
Author: georg.brandl
Date: Sat Jul 18 11:43:40 2009
New Revision: 74077
Log:
#6489: fix an ambiguity in getiterator() documentation.
Modified:
python/trunk/Doc/library/xml.etree.elementtree.rst
Modified: python/trunk/Doc/library/xml.etree.elementtree.rst
==============================================================================
--- python/trunk/Doc/library/xml.etree.elementtree.rst (original)
+++ python/trunk/Doc/library/xml.etree.elementtree.rst Sat Jul 18 11:43:40 2009
@@ -262,9 +262,9 @@
.. method:: Element.getiterator([tag=None])
Creates a tree iterator with the current element as the root. The iterator
- iterates over this element and all elements below it that match the given tag.
- If tag is ``None`` or ``'*'`` then all elements are iterated over. Returns an
- iterable that provides element objects in document (depth first) order.
+ iterates over this element and all elements below it, in document (depth first)
+ order. If *tag* is not ``None`` or ``'*'``, only elements whose tag equals
+ *tag* are returned from the iterator.
.. method:: Element.insert(index, element)
More information about the Python-checkins
mailing list