summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/iter.rst
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2013-10-10 05:42:46 (GMT)
committerRaymond Hettinger <python@rcn.com>2013-10-10 05:42:46 (GMT)
commit8ee7708c7f7906f794a4f97ea2f9347e605ee245 (patch)
treef58498423ca407c200972f6f6c0def2c8826b520 /Doc/c-api/iter.rst
parent3415fa3c6e3b772eccb2b694ad92189de0eb8acb (diff)
downloadcpython-8ee7708c7f7906f794a4f97ea2f9347e605ee245.zip
cpython-8ee7708c7f7906f794a4f97ea2f9347e605ee245.tar.gz
cpython-8ee7708c7f7906f794a4f97ea2f9347e605ee245.tar.bz2
Issue #19005: Fix documentation for PyIter_Next().
Diffstat (limited to 'Doc/c-api/iter.rst')
-rw-r--r--Doc/c-api/iter.rst11
1 files changed, 5 insertions, 6 deletions
diff --git a/Doc/c-api/iter.rst b/Doc/c-api/iter.rst
index 3f0f554..2ba444d 100644
--- a/Doc/c-api/iter.rst
+++ b/Doc/c-api/iter.rst
@@ -5,7 +5,7 @@
Iterator Protocol
=================
-There are only a couple of functions specifically for working with iterators.
+There are two functions specifically for working with iterators.
.. c:function:: int PyIter_Check(PyObject *o)
@@ -14,11 +14,10 @@ There are only a couple of functions specifically for working with iterators.
.. c:function:: PyObject* PyIter_Next(PyObject *o)
- Return the next value from the iteration *o*. If the object is an iterator,
- this retrieves the next value from the iteration, and returns *NULL* with no
- exception set if there are no remaining items. If the object is not an
- iterator, :exc:`TypeError` is raised, or if there is an error in retrieving the
- item, returns *NULL* and passes along the exception.
+ Return the next value from the iteration *o*. The object must be an iterator
+ (it is up to the caller to check this). If there are no remaining values,
+ returns *NULL* with no exception set. If an error occurs while retrieving
+ the item, returns *NULL* and passes along the exception.
To write a loop which iterates over an iterator, the C code should look
something like this::