]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Document PyType_IS_GC().
authorFred Drake <fdrake@acm.org>
Wed, 10 Apr 2002 18:16:32 +0000 (18:16 +0000)
committerFred Drake <fdrake@acm.org>
Wed, 10 Apr 2002 18:16:32 +0000 (18:16 +0000)
Update description of PyType_Check().

Doc/api/api.tex

index c0173c7c65d4e37eeacc219d0b6e01d981fa865b..2df59f5ee41bba8aab9f1b52e3cba59e7371d07f 100644 (file)
@@ -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}}