diff options
| author | Georg Brandl <georg@python.org> | 2010-10-06 10:11:56 +0000 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-10-06 10:11:56 +0000 |
| commit | 60203b41b03d03361754d264543d5fbe6259eb25 (patch) | |
| tree | 005d0d6be6437244ae360ebc0d65fa7b149a8093 /Doc/c-api/iterator.rst | |
| parent | 64a41edb039afee683d69bd6f72e3709ff11bd93 (diff) | |
| download | cpython-git-60203b41b03d03361754d264543d5fbe6259eb25.tar.gz | |
Migrate to Sphinx 1.0 C language constructs.
Diffstat (limited to 'Doc/c-api/iterator.rst')
| -rw-r--r-- | Doc/c-api/iterator.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/Doc/c-api/iterator.rst b/Doc/c-api/iterator.rst index 86650800a4..82cb4eba8a 100644 --- a/Doc/c-api/iterator.rst +++ b/Doc/c-api/iterator.rst @@ -12,37 +12,37 @@ the callable for each item in the sequence, and ending the iteration when the sentinel value is returned. -.. cvar:: PyTypeObject PySeqIter_Type +.. c:var:: PyTypeObject PySeqIter_Type - Type object for iterator objects returned by :cfunc:`PySeqIter_New` and the + Type object for iterator objects returned by :c:func:`PySeqIter_New` and the one-argument form of the :func:`iter` built-in function for built-in sequence types. -.. cfunction:: int PySeqIter_Check(op) +.. c:function:: int PySeqIter_Check(op) - Return true if the type of *op* is :cdata:`PySeqIter_Type`. + Return true if the type of *op* is :c:data:`PySeqIter_Type`. -.. cfunction:: PyObject* PySeqIter_New(PyObject *seq) +.. c:function:: PyObject* PySeqIter_New(PyObject *seq) Return an iterator that works with a general sequence object, *seq*. The iteration ends when the sequence raises :exc:`IndexError` for the subscripting operation. -.. cvar:: PyTypeObject PyCallIter_Type +.. c:var:: PyTypeObject PyCallIter_Type - Type object for iterator objects returned by :cfunc:`PyCallIter_New` and the + Type object for iterator objects returned by :c:func:`PyCallIter_New` and the two-argument form of the :func:`iter` built-in function. -.. cfunction:: int PyCallIter_Check(op) +.. c:function:: int PyCallIter_Check(op) - Return true if the type of *op* is :cdata:`PyCallIter_Type`. + Return true if the type of *op* is :c:data:`PyCallIter_Type`. -.. cfunction:: PyObject* PyCallIter_New(PyObject *callable, PyObject *sentinel) +.. c:function:: PyObject* PyCallIter_New(PyObject *callable, PyObject *sentinel) Return a new iterator. The first parameter, *callable*, can be any Python callable object that can be called with no parameters; each call to it should |
