Mercurial > cpython-lru_cache-weakref
diff Doc/c-api/iterator.rst @ 74395:74ff71b2f53d 2.7
update to new C roles and directives
| author | Sandro Tosi <sandro.tosi@gmail.com> |
|---|---|
| date | Sat, 14 Jan 2012 16:42:02 +0100 |
| parents | 13dc65fe8599 |
| children |
line wrap: on
line diff
--- a/Doc/c-api/iterator.rst Sat Jan 14 16:41:26 2012 +0100 +++ b/Doc/c-api/iterator.rst Sat Jan 14 16:42:02 2012 +0100 @@ -12,23 +12,23 @@ 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. .. versionadded:: 2.2 -.. 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`. .. versionadded:: 2.2 -.. 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 @@ -37,22 +37,22 @@ .. versionadded:: 2.2 -.. 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. .. versionadded:: 2.2 -.. 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`. .. versionadded:: 2.2 -.. 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
