classification
Title: Documentation of ElementTree.Element.getiterator implies element will always be included
Type: Stage:
Components: Documentation Versions: Python 3.0, Python 3.1, Python 3.2, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: MLModel, effbot, georg.brandl
Priority: low Keywords:

Created on 2009-07-15 02:02 by MLModel, last changed 2009-07-18 09:43 by georg.brandl. This issue is now closed.

Messages (2)
msg90529 - (view) Author: Mitchell Model (MLModel) Date: 2009-07-15 02:02
Documentation of ElementTree.Element.getiterator implies element will
always be included, but it is only included if it matches. (It says
"creates a tree iterator with the current element as the root" and also
says, ambiguously, "iterates over this element and all the elements
below it that match the given tag".)

I also feel that it is unclear to leave the term "match" undescribed.
Especially with '*' explicitly mentioned as a possibility, it looks like
one could specify, say, 'Thing*' and get all elements whose tag names
begin with 'Thing', which does not appear to be the case. Also, using
the term "match" is confusing if one understands the term to mean match
an XPath, as (implicitly) used elsewhere in the document, unless match
also means an XPath here too, which I don't think it does. I think
"match" should be reserved for XPath matching in this documentation, and
"equals" for when that is the actual test performed, such as, I think,
in getiterator.
msg90667 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-07-18 09:43
Fixed in r74077.
History
Date User Action Args
2009-07-18 09:43:47georg.brandlsetstatus: open -> closed
assignee: effbot -> georg.brandl
resolution: fixed
messages: + msg90667
2009-07-15 03:02:22ezio.melottisetpriority: low
assignee: georg.brandl -> effbot

nosy: + effbot
2009-07-15 02:02:18MLModelcreate