[docs] In xml.etree.ElementTree docs there are many absent Element class links (issue 28234)
vadmium+py at gmail.com
vadmium+py at gmail.com
Wed Sep 21 21:36:09 EDT 2016
https://bugs.python.org/review/28234/diff/18635/Doc/library/xml.etree.elementtree.rst
File Doc/library/xml.etree.elementtree.rst (right):
https://bugs.python.org/review/28234/diff/18635/Doc/library/xml.etree.elementtree.rst#newcode507
Doc/library/xml.etree.elementtree.rst:507: :class:`Element` instance.
Returns a true value if this is an element object.
This does not make much sense. How could *element* be an Element class
instance, but _not_ an “element object”? Maybe drop at least one of the
sentences?
The implementation seems to check for a “tag” attribute. It used to have
an alternative check for an Element class instance, but that was
removed.
https://bugs.python.org/review/28234/diff/18635/Doc/library/xml.etree.elementtree.rst#newcode582
Doc/library/xml.etree.elementtree.rst:582: arguments. Returns an
:class:`Element` instance.
Wouldn’t it be clearer to say _what_ element it returns (new child,
parent, or something else)?
https://bugs.python.org/review/28234/
More information about the docs
mailing list