]> granicus.if.org Git - python/commitdiff
#6489: fix an ambiguity in getiterator() documentation.
authorGeorg Brandl <georg@python.org>
Sat, 18 Jul 2009 09:43:40 +0000 (09:43 +0000)
committerGeorg Brandl <georg@python.org>
Sat, 18 Jul 2009 09:43:40 +0000 (09:43 +0000)
Doc/library/xml.etree.elementtree.rst

index 38545c2083a0462d07756638f115a68544976efa..e074d554a0f43d344e0cc6ef3edfb5d71fc787e3 100644 (file)
@@ -262,9 +262,9 @@ The following methods work on the element's children (subelements).
 .. 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)