From: Fred Drake <fdrake@acm.org>
Date: Tue, 24 Sep 2002 16:44:56 +0000 (+0000)
Subject: Clarify documentation for PyErr_SetObject() to describe the reference
X-Git-Tag: v2.2.2b1~125
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1884af0643246f888a6e82629439dcb57d12a998;p=thirdparty%2FPython%2Fcpython.git

Clarify documentation for PyErr_SetObject() to describe the reference
count behavior.
---

diff --git a/Doc/api/exceptions.tex b/Doc/api/exceptions.tex
index 046130d04528..b2d5f1aacc7c 100644
--- a/Doc/api/exceptions.tex
+++ b/Doc/api/exceptions.tex
@@ -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,