summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2007-09-01 16:19:25 (GMT)
committerGeorg Brandl <georg@python.org>2007-09-01 16:19:25 (GMT)
commitb355304ea49ea50a539f1df01ad79b763225d1c6 (patch)
treeecc35bdd66f71c0469d853e51488e7269e4ca98c
parenta6f52786b74c97d22cb136d0a3b7e36bdd2316ab (diff)
downloadcpython-b355304ea49ea50a539f1df01ad79b763225d1c6.zip
cpython-b355304ea49ea50a539f1df01ad79b763225d1c6.tar.gz
cpython-b355304ea49ea50a539f1df01ad79b763225d1c6.tar.bz2
Document PyCFunctionWithKeywords, add comment for PEP 3123.
-rw-r--r--Doc/c-api/newtypes.rst11
1 files changed, 10 insertions, 1 deletions
diff --git a/Doc/c-api/newtypes.rst b/Doc/c-api/newtypes.rst
index 91efe4b..0fe1daa 100644
--- a/Doc/c-api/newtypes.rst
+++ b/Doc/c-api/newtypes.rst
@@ -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