diff options
| author | Sandro Tosi <sandro.tosi@gmail.com> | 2012-01-14 15:42:02 (GMT) |
|---|---|---|
| committer | Sandro Tosi <sandro.tosi@gmail.com> | 2012-01-14 15:42:02 (GMT) |
| commit | 98ed08f24e4b7b7a5d82fb1e07ad5a0319291c2b (patch) | |
| tree | ea97c15200ee6221998e0ea6eb1ca5f1b3faccd7 /Doc/c-api/gen.rst | |
| parent | bbd41d0874c49f756b3a7bcdcbf1e5ac61137377 (diff) | |
| download | cpython-98ed08f24e4b7b7a5d82fb1e07ad5a0319291c2b.zip cpython-98ed08f24e4b7b7a5d82fb1e07ad5a0319291c2b.tar.gz cpython-98ed08f24e4b7b7a5d82fb1e07ad5a0319291c2b.tar.bz2 | |
update to new C roles and directives
Diffstat (limited to 'Doc/c-api/gen.rst')
| -rw-r--r-- | Doc/c-api/gen.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Doc/c-api/gen.rst b/Doc/c-api/gen.rst index 0d3789a..33cd27a 100644 --- a/Doc/c-api/gen.rst +++ b/Doc/c-api/gen.rst @@ -7,31 +7,31 @@ Generator Objects Generator objects are what Python uses to implement generator iterators. They are normally created by iterating over a function that yields values, rather -than explicitly calling :cfunc:`PyGen_New`. +than explicitly calling :c:func:`PyGen_New`. -.. ctype:: PyGenObject +.. c:type:: PyGenObject The C structure used for generator objects. -.. cvar:: PyTypeObject PyGen_Type +.. c:var:: PyTypeObject PyGen_Type The type object corresponding to generator objects -.. cfunction:: int PyGen_Check(ob) +.. c:function:: int PyGen_Check(ob) Return true if *ob* is a generator object; *ob* must not be *NULL*. -.. cfunction:: int PyGen_CheckExact(ob) +.. c:function:: int PyGen_CheckExact(ob) Return true if *ob*'s type is *PyGen_Type* is a generator object; *ob* must not be *NULL*. -.. cfunction:: PyObject* PyGen_New(PyFrameObject *frame) +.. c:function:: PyObject* PyGen_New(PyFrameObject *frame) Create and return a new generator object based on the *frame* object. A reference to *frame* is stolen by this function. The parameter must not be |