[Python-3000-checkins] r57877 - python/branches/py3k/Doc/c-api/newtypes.rst

[georg.brandl]

Author: georg.brandl
Date: Sat Sep  1 18:19:25 2007
New Revision: 57877

Modified:
   python/branches/py3k/Doc/c-api/newtypes.rst
Log:
Document PyCFunctionWithKeywords, add comment for PEP 3123.


Modified: python/branches/py3k/Doc/c-api/newtypes.rst
==============================================================================
--- python/branches/py3k/Doc/c-api/newtypes.rst	(original)
+++ python/branches/py3k/Doc/c-api/newtypes.rst	Sat Sep  1 18:19:25 2007
@@ -139,6 +139,7 @@
 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 @@
    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 @@
    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