summaryrefslogtreecommitdiffstats
path: root/Doc/library/xml.etree.elementtree.rst
diff options
context:
space:
mode:
authorEli Bendersky <eliben@gmail.com>2013-08-04 01:55:10 (GMT)
committerEli Bendersky <eliben@gmail.com>2013-08-04 01:55:10 (GMT)
commitc4216ab92be06368a9edc4416b20ee5c9304ef3d (patch)
treeeaf5e8d216b11611aa2d38a11c3f092e0d2598b9 /Doc/library/xml.etree.elementtree.rst
parentb9b6ce6f2c687092dfc99c912e52cdc32ae44c3d (diff)
parentca97fd305394d48c0050cd230ce41a057fd71636 (diff)
downloadcpython-c4216ab92be06368a9edc4416b20ee5c9304ef3d.zip
cpython-c4216ab92be06368a9edc4416b20ee5c9304ef3d.tar.gz
cpython-c4216ab92be06368a9edc4416b20ee5c9304ef3d.tar.bz2
Issue #17902: Clarify doc of ElementTree.iterparse and IncrementalParser
Based on patch by Aaron Oakley
Diffstat (limited to 'Doc/library/xml.etree.elementtree.rst')
-rw-r--r--Doc/library/xml.etree.elementtree.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst
index d0bfed0..c0cc683 100644
--- a/Doc/library/xml.etree.elementtree.rst
+++ b/Doc/library/xml.etree.elementtree.rst
@@ -416,7 +416,8 @@ Functions
and ``"end-ns"`` (the "ns" events are used to get detailed namespace
information). If *events* is omitted, only ``"end"`` events are reported.
*parser* is an optional parser instance. If not given, the standard
- :class:`XMLParser` parser is used. Returns an :term:`iterator` providing
+ :class:`XMLParser` parser is used. *parser* can only use the default
+ :class:`TreeBuilder` as a target. Returns an :term:`iterator` providing
``(event, elem)`` pairs.
Note that while :func:`iterparse` builds the tree incrementally, it issues
@@ -880,7 +881,7 @@ IncrementalParser Objects
events are used to get detailed namespace information). If *events* is
omitted, only ``"end"`` events are reported. *parser* is an optional
parser instance. If not given, the standard :class:`XMLParser` parser is
- used.
+ used. *parser* can only use the default :class:`TreeBuilder` as a target.
.. method:: data_received(data)