Issue #11367: fix documentation of some find* methods in ElementTree

This commit is contained in:
Eli Bendersky 2013-03-12 06:01:22 -07:00
parent c30b7b16ea
commit 7343cb0790
3 changed files with 8 additions and 19 deletions

View file

@ -412,26 +412,17 @@ ElementTree Objects
.. method:: find(match)
Finds the first toplevel element matching *match*. *match* may be a tag
name or path. Same as getroot().find(match). Returns the first matching
element, or ``None`` if no element was found.
Same as :meth:`Element.find`, starting at the root of the tree.
.. method:: findall(match)
Finds all matching subelements, by tag name or path. Same as
getroot().findall(match). *match* may be a tag name or path. Returns a
list containing all matching elements, in document order.
Same as :meth:`Element.findall`, starting at the root of the tree.
.. method:: findtext(match, default=None)
Finds the element text for the first toplevel element with given tag.
Same as getroot().findtext(match). *match* may be a tag name or path.
*default* is the value to return if the element was not found. Returns
the text content of the first matching element, or the default value no
element was found. Note that if the element is found, but has no text
content, this method returns an empty string.
Same as :meth:`Element.findtext`, starting at the root of the tree.
.. method:: getiterator(tag=None)