diff options
| author | Eli Bendersky <eliben@gmail.com> | 2013-08-24 22:11:44 (GMT) |
|---|---|---|
| committer | Eli Bendersky <eliben@gmail.com> | 2013-08-24 22:11:44 (GMT) |
| commit | bfd78370a59863e0f1715d122cc1e4b26101028e (patch) | |
| tree | 315bf8eef189a8a23cc63302b8f9aca7e62ee3b3 | |
| parent | 1544fc53129afad4d50ce15e2f3cd4f6bf08fc1c (diff) | |
| download | cpython-bfd78370a59863e0f1715d122cc1e4b26101028e.zip cpython-bfd78370a59863e0f1715d122cc1e4b26101028e.tar.gz cpython-bfd78370a59863e0f1715d122cc1e4b26101028e.tar.bz2 | |
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.
| -rw-r--r-- | Doc/library/xml.etree.elementtree.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index c0cc683..6bafbe7 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) |