From: Georg Brandl Date: Sat, 18 Jul 2009 09:43:40 +0000 (+0000) Subject: #6489: fix an ambiguity in getiterator() documentation. X-Git-Tag: v2.7a1~744 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3bb474714ba859a008cd51545372eb2dfc63a349;p=python #6489: fix an ambiguity in getiterator() documentation. --- diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index 38545c2083..e074d554a0 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -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)