Document PyCFunctionWithKeywords, add comment for PEP 3123.
authorGeorg Brandl <georg@python.org>
Sat, 1 Sep 2007 16:19:25 +0000 (16:19 +0000)
committerGeorg Brandl <georg@python.org>
Sat, 1 Sep 2007 16:19:25 +0000 (16:19 +0000)
Doc/c-api/newtypes.rst

index 91efe4b3d329a4f78e7f205a6365db73bab17d54..0fe1daa1ed680d36278cd53c5e885e5120869cbd 100644 (file)
@@ -139,6 +139,7 @@ definition of all other Python objects.
 These macros are used in the definition of :ctype:`PyObject` and
 :ctype:`PyVarObject`:
 
+.. XXX need to document PEP 3123 changes here
 
 .. cmacro:: PyObject_HEAD
 
@@ -171,7 +172,7 @@ These macros are used in the definition of :ctype:`PyObject` and
    Note that :cmacro:`PyObject_HEAD` is part of the expansion, and that its own
    expansion varies depending on the definition of :cmacro:`Py_TRACE_REFS`.
 
-PyObject_HEAD_INIT
+.. cmacro:: PyObject_HEAD_INIT
 
 
 .. ctype:: PyCFunction
@@ -183,6 +184,14 @@ PyObject_HEAD_INIT
    in Python.  The function must return a new reference.
 
 
+.. ctype:: PyCFunctionWithKeywords
+
+   Type of the functions used to implement Python callables in C that take
+   keyword arguments: they take three :ctype:`PyObject\*` parameters and return
+   one such value.  See :ctype:`PyCFunction` above for the meaning of the return
+   value.
+
+
 .. ctype:: PyMethodDef
 
    Structure used to describe a method of an extension type.  This structure has