traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

#2727: clarify tp_iternext docs.

This commit is contained in:
Georg Brandl 2008-04-30 20:02:37 +00:00
parent 28e0873f1f
commit 63b0a2eb21
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Doc/c-api/typeobj.rst
View File

@ -753,11 +753,12 @@ set.
.. cmember:: iternextfunc PyTypeObject.tp_iternext
An optional pointer to a function that returns the next item in an iterator, or
raises :exc:`StopIteration` when the iterator is exhausted. Its presence
normally signals that the instances of this type are iterators (although classic
instances always have this function, even if they don't define a :meth:`next`
method).
An optional pointer to a function that returns the next item in an iterator.
When the iterator is exhausted, it must return *NULL*; a :exc:`StopIteration`
exception may or may not be set. When another error occurs, it must return
*NULL* too. Its presence normally signals that the instances of this type
are iterators (although classic instances always have this function, even if
they don't define a :meth:`next` method).
Iterator types should also define the :attr:`tp_iter` function, and that
function should return the iterator instance itself (not a new iterator