]> granicus.if.org Git - python/commitdiff
Clarify documentation for PyErr_SetObject() to describe the reference
authorFred Drake <fdrake@acm.org>
Tue, 24 Sep 2002 16:45:16 +0000 (16:45 +0000)
committerFred Drake <fdrake@acm.org>
Tue, 24 Sep 2002 16:45:16 +0000 (16:45 +0000)
count behavior.

Doc/api/exceptions.tex

index 80f1353f6d0971a39a4c936be2eaeea713b750e4..88bf00d102df13135e792b5ccbb2658741c0a385 100644 (file)
@@ -124,7 +124,7 @@ for each thread.
 \begin{cfuncdesc}{void}{PyErr_SetObject}{PyObject *type, PyObject *value}
   This function is similar to \cfunction{PyErr_SetString()} but lets
   you specify an arbitrary Python object for the ``value'' of the
-  exception.  You need not increment its reference count.
+  exception.  One reference to \var{value} is stolen.
 \end{cfuncdesc}
 
 \begin{cfuncdesc}{PyObject*}{PyErr_Format}{PyObject *exception,