mirrors/cpython
mirrors/cpython
0
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2024-12-01 11:15:56 +01:00
Code Issues Releases Activity

Merged revisions 62602 via svnmerge from

Browse Source 
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r62602 | georg.brandl | 2008-04-30 22:02:37 +0200 (Wed, 30 Apr 2008) | 2 lines

  #2727: clarify tp_iternext docs.
........
This commit is contained in:
Georg Brandl 2008-04-30 20:06:53 +00:00
parent c71520eba7
commit f392057eb1
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -739,9 +739,11 @@ 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.
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 signals that the instances of this type are
iterators.
Iterator types should also define the :attr:`tp_iter` function, and that
function should return the iterator instance itself (not a new iterator