From: Fred Drake <fdrake@acm.org>
Date: Wed, 10 Apr 2002 18:16:32 +0000 (+0000)
Subject: Document PyType_IS_GC().
X-Git-Tag: 2.1~69
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ba9c5659f0a61c492958e87a1d84ee821927bc41;p=thirdparty%2FPython%2Fcpython.git

Document PyType_IS_GC().
Update description of PyType_Check().
---

diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index c0173c7c65d4..2df59f5ee41b 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -2192,7 +2192,9 @@ This is the type object for type objects; it is the same object as
 \end{cvardesc}
 
 \begin{cfuncdesc}{int}{PyType_Check}{PyObject *o}
-Returns true is the object \var{o} is a type object.
+Returns true if the object \var{o} is a type object, including
+instances of types derived from the standard type object.  Returns
+false in all other cases.
 \end{cfuncdesc}
 
 \begin{cfuncdesc}{int}{PyType_HasFeature}{PyObject *o, int feature}
@@ -2200,6 +2202,12 @@ Returns true if the type object \var{o} sets the feature
 \var{feature}.  Type features are denoted by single bit flags.
 \end{cfuncdesc}
 
+\begin{cfuncdesc}{int}{PyType_IS_GC}{PyObject *o}
+Return true if the type object includes support for the cycle
+detector; this tests the type flag \constant{Py_TPFLAGS_HAVE_GC}.
+\versionadded{2.0}
+\end{cfuncdesc}
+
 
 \subsection{The None Object \label{noneObject}}