summaryrefslogtreecommitdiffstats
path: root/Doc/api
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-05-13 18:41:14 (GMT)
committerFred Drake <fdrake@acm.org>1999-05-13 18:41:14 (GMT)
commitdab44682c2974d504143d69c00f78fa7719f7810 (patch)
tree5a806c8a90b7dbbf6c31200d079140b0228b0d8c /Doc/api
parent431f0ce547e865a6856df2dd9894046932a875c2 (diff)
downloadcpython-dab44682c2974d504143d69c00f78fa7719f7810.zip
cpython-dab44682c2974d504143d69c00f78fa7719f7810.tar.gz
cpython-dab44682c2974d504143d69c00f78fa7719f7810.tar.bz2
PyCObject_FromVoidPtr(): Clarify that the destr function will only be
called on destruction is non-NULL.
Diffstat (limited to 'Doc/api')
-rw-r--r--Doc/api/api.tex3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index 4cce62b..a625d14 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -2384,7 +2384,8 @@ used to access C APIs defined in dynamically loaded modules.
\begin{cfuncdesc}{PyObject *}{PyCObject_FromVoidPtr}{void* cobj,
void (*destr)(void *)}
Creates a \ctype{PyCObject} from the \code{void *} \var{cobj}. The
-\var{destr} function will be called when the object is reclaimed.
+\var{destr} function will be called when the object is reclaimed, unless
+it is \NULL.
\end{cfuncdesc}
\begin{cfuncdesc}{PyObject *}{PyCObject_FromVoidPtrAndDesc}{void* cobj,