diff options
| author | Georg Brandl <georg@python.org> | 2009-07-18 09:43:40 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-07-18 09:43:40 (GMT) |
| commit | 3bb474714ba859a008cd51545372eb2dfc63a349 (patch) | |
| tree | a83d331841b94fdc9df50725a89ecec74b3dbe02 | |
| parent | a1a4bdb30cc0682be2c8c20fdba7adb2a4a643e1 (diff) | |
| download | cpython-3bb474714ba859a008cd51545372eb2dfc63a349.zip cpython-3bb474714ba859a008cd51545372eb2dfc63a349.tar.gz cpython-3bb474714ba859a008cd51545372eb2dfc63a349.tar.bz2 | |
#6489: fix an ambiguity in getiterator() documentation.
| -rw-r--r-- | Doc/library/xml.etree.elementtree.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index 38545c2..e074d55 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) |