[Python-checkins] cpython (3.3): Issue #19452: Clarify the documentation of iterparse w.r.t. events argument.

[eli.bendersky]

http://hg.python.org/cpython/rev/e6941225e014
changeset:   86798:e6941225e014
branch:      3.3
parent:      86793:7c2b521aaaa9
user:        Eli Bendersky <eliben at gmail.com>
date:        Thu Oct 31 05:53:39 2013 -0700
summary:
  Issue #19452: Clarify the documentation of iterparse w.r.t. events argument.

In 3.3 iterparse accepts a tuple in events (the C accelerator enforces this).
This limitation was lifted in Python 3.4

files:
  Doc/library/xml.etree.elementtree.rst |  2 +-
  1 files changed, 1 insertions(+), 1 deletions(-)


diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst
--- a/Doc/library/xml.etree.elementtree.rst
+++ b/Doc/library/xml.etree.elementtree.rst
@@ -379,7 +379,7 @@
 
    Parses an XML section into an element tree incrementally, and reports what's
    going on to the user.  *source* is a filename or :term:`file object`
-   containing XML data.  *events* is a list of events to report back.  The
+   containing XML data.  *events* is a tuple of events to report back.  The
    supported events are the strings ``"start"``, ``"end"``, ``"start-ns"``
    and ``"end-ns"`` (the "ns" events are used to get detailed namespace
    information).  If *events* is omitted, only ``"end"`` events are reported.

-- 
Repository URL: http://hg.python.org/cpython