From: Eli Bendersky <eliben@gmail.com>
Date: Sat, 24 Aug 2013 22:11:44 +0000 (-0700)
Subject: Clarify the documentation of XMLParser.close
X-Git-Tag: v3.4.0a2~126
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=bfd78370a59863e0f1715d122cc1e4b26101028e;p=python

Clarify the documentation of XMLParser.close

The return value of close() is not always a toplevel element. It depends on
what the underlying target returns. By default, TreeBuilder returns the
toplevel document element.
---

diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst
index c0cc683068..6bafbe7082 100644
--- a/Doc/library/xml.etree.elementtree.rst
+++ b/Doc/library/xml.etree.elementtree.rst
@@ -982,7 +982,9 @@ XMLParser Objects
 
    .. method:: close()
 
-      Finishes feeding data to the parser.  Returns an element structure.
+      Finishes feeding data to the parser.  Returns the result of calling the
+      `close` method of the *target* passed during construction; by default,
+      this is the toplevel document element.
 
 
    .. method:: doctype(name, pubid, system)