summaryrefslogtreecommitdiff
path: root/c/ffi_obj.c
diff options
context:
space:
mode:
authorArmin Rigo <arigo@tunes.org>2015-11-15 11:17:23 +0100
committerArmin Rigo <arigo@tunes.org>2015-11-15 11:17:23 +0100
commit5b42f8dfbc1aa5ca0f20a441c31331a27f584f6c (patch)
treeb9ebdd32535e7451367fe7dccd379d4026aa9f38 /c/ffi_obj.c
parentc92ca0e6527f23a9ca7537072468cca079b70fe0 (diff)
downloadcffi-5b42f8dfbc1aa5ca0f20a441c31331a27f584f6c.tar.gz
Inline documentation
Diffstat (limited to 'c/ffi_obj.c')
-rw-r--r--c/ffi_obj.c9
1 files changed, 8 insertions, 1 deletions
diff --git a/c/ffi_obj.c b/c/ffi_obj.c
index fd154b3..a82423a 100644
--- a/c/ffi_obj.c
+++ b/c/ffi_obj.c
@@ -745,7 +745,14 @@ PyDoc_STRVAR(ffi_gc_doc,
from _cffi_backend.c */
PyDoc_STRVAR(ffi_call_python_doc,
-"XXX document me");
+"A decorator. Attaches the decorated Python function to the C code\n"
+"generated for the CFFI_CALL_PYTHON function of the same name. Calling\n"
+"the C function will then invoke the Python function.\n"
+"\n"
+"Optional arguments: 'name' is the name of the C function, if\n"
+"different from the Python function; and 'error' and 'onerror'\n"
+"handle what occurs if the Python function raises an exception\n"
+"(see the docs for details).");
/* forward; see call_python.c */
static PyObject *_ffi_call_python_decorator(PyObject *, PyObject *);