[Python-3000-checkins] r62603 - in python/branches/py3k: Doc/c-api/typeobj.rst

[georg.brandl]

Author: georg.brandl
Date: Wed Apr 30 22:06:53 2008
New Revision: 62603

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


Modified:
   python/branches/py3k/   (props changed)
   python/branches/py3k/Doc/c-api/typeobj.rst

Modified: python/branches/py3k/Doc/c-api/typeobj.rst
==============================================================================
--- python/branches/py3k/Doc/c-api/typeobj.rst	(original)
+++ python/branches/py3k/Doc/c-api/typeobj.rst	Wed Apr 30 22:06:53 2008
@@ -739,9 +739,11 @@
 
 .. 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