From 7343cb0790d3ac722ee788d5c2044cbda770a140 Mon Sep 17 00:00:00 2001 From: Eli Bendersky Date: Tue, 12 Mar 2013 06:01:22 -0700 Subject: Issue #11367: fix documentation of some find* methods in ElementTree --- Doc/library/xml.etree.elementtree.rst | 15 +++------------ Lib/xml/etree/ElementTree.py | 11 ++++------- Misc/ACKS | 1 + 3 files changed, 8 insertions(+), 19 deletions(-) diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index d320711..cf0c33f 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -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) diff --git a/Lib/xml/etree/ElementTree.py b/Lib/xml/etree/ElementTree.py index ff8ff7d..e361eff 100644 --- a/Lib/xml/etree/ElementTree.py +++ b/Lib/xml/etree/ElementTree.py @@ -705,8 +705,7 @@ class ElementTree: return list(self.iter(tag)) ## - # Finds the first toplevel element with given tag. - # Same as getroot().find(path). + # Same as getroot().find(path), starting at the root of the tree. # # @param path What element to look for. # @keyparam namespaces Optional namespace prefix map. @@ -726,10 +725,9 @@ class ElementTree: return self._root.find(path, namespaces) ## - # Finds the element text for the first toplevel element with given - # tag. Same as getroot().findtext(path). + # Same as getroot().findtext(path), starting at the root of the tree. # - # @param path What toplevel element to look for. + # @param path What element to look for. # @param default What to return if the element was not found. # @keyparam namespaces Optional namespace prefix map. # @return The text content of the first matching element, or the @@ -751,8 +749,7 @@ class ElementTree: return self._root.findtext(path, default, namespaces) ## - # Finds all toplevel elements with the given tag. - # Same as getroot().findall(path). + # Same as getroot().findall(path), starting at the root of the tree. # # @param path What element to look for. # @keyparam namespaces Optional namespace prefix map. diff --git a/Misc/ACKS b/Misc/ACKS index 58f6648..f02ef23 100644 --- a/Misc/ACKS +++ b/Misc/ACKS @@ -436,6 +436,7 @@ Janko Hauser Rycharde Hawkes Ben Hayden Jochen Hayek +Henrik Heimbuerger Christian Heimes Thomas Heller Malte Helmert -- cgit v0.12