summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Bendersky <eliben@gmail.com>2013-01-24 15:23:34 (GMT)
committerEli Bendersky <eliben@gmail.com>2013-01-24 15:23:34 (GMT)
commit48c50bf4c84636bd92ecd77572120328cd38ee51 (patch)
treedff6ec8bb3682ad667827fa25323441acb90a80e
parent385ecd84c8e450ace7accaaf2bcfe48b5622bc62 (diff)
downloadcpython-48c50bf4c84636bd92ecd77572120328cd38ee51.zip
cpython-48c50bf4c84636bd92ecd77572120328cd38ee51.tar.gz
cpython-48c50bf4c84636bd92ecd77572120328cd38ee51.tar.bz2
Clarify ET.iterparse documentation - this function is not supported by the
C implementation.
-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 d9b0a52..d320711 100644
--- a/Doc/library/xml.etree.elementtree.rst
+++ b/Doc/library/xml.etree.elementtree.rst
@@ -101,8 +101,9 @@ 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
- ``(event, elem)`` pairs.
+ :class:`XMLParser` parser is used. *parser* is not supported by
+ ``cElementTree``. Returns an :term:`iterator` providing ``(event, elem)``
+ pairs.
.. note::