From: Fred Drake <fdrake@acm.org>
Date: Wed, 9 Apr 2003 18:17:18 +0000 (+0000)
Subject: Backport comments about PyObject_Type() (HEAD revisions 1.24, 1.25).
X-Git-Tag: v2.2.3c1~75
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=273888e56c4605bcaa14b8717dc747a7b1f142f1;p=thirdparty%2FPython%2Fcpython.git

Backport comments about PyObject_Type() (HEAD revisions 1.24, 1.25).
---

diff --git a/Doc/api/abstract.tex b/Doc/api/abstract.tex
index 952b3d63a8a5..ee26a27eae9a 100644
--- a/Doc/api/abstract.tex
+++ b/Doc/api/abstract.tex
@@ -296,9 +296,13 @@ determination.
 \begin{cfuncdesc}{PyObject*}{PyObject_Type}{PyObject *o}
   When \var{o} is non-\NULL, returns a type object corresponding to
   the object type of object \var{o}. On failure, raises
-  \exception{SystemError} and returns \NULL.  This is equivalent to
-  the Python expression \code{type(\var{o})}.
-  \bifuncindex{type}
+  \exception{SystemError} and returns \NULL.\bifuncindex{type}
+  This is equivalent to the Python expression \code{type(\var{o})}.
+  This function increments the reference count of the return value.
+  There's really no reason to use this function instead of the
+  common expression \code{\var{o}->ob_type}, which returns a pointer
+  of type \ctype{PyTypeObject*}, except when the incremented reference
+  count is needed.
 \end{cfuncdesc}
 
 \begin{cfuncdesc}{int}{PyObject_TypeCheck}{PyObject *o, PyTypeObject *type}