Merged revisions 62602 via svnmerge from

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.
........

diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
index 83bef7d3c5b8bdc5576caacdef6cc41e11625e81..6b7c4ac9dc67280b61eee59acbceb94022b38708 100644 (file)
--- a/Doc/c-api/typeobj.rst
+++ b/Doc/c-api/typeobj.rst
@@ -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