Mailing List Archive

Update of /cvsroot/python/python/dist/src/Doc/api
In directory usw-pr-cvs1:/tmp/cvs-serv23455/api

Modified Files:
abstract.tex
Log Message:
Clarify the return value of PyObject_IsInstance().

Index: abstract.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/abstract.tex,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -d -r1.12 -r1.13
*** abstract.tex 15 Apr 2002 20:51:19 -0000 1.12
--- abstract.tex 23 Apr 2002 18:15:44 -0000 1.13
***************
*** 130,141 ****

\begin{cfuncdesc}{int}{PyObject_IsInstance}{PyObject *inst, PyObject *cls}
! Return \code{1} if \var{inst} is an instance of the class \var{cls}
! or a subclass of \var{cls}. If \var{cls} is a type object rather
! than a class object, \cfunction{PyObject_IsInstance()} returns
! \code{1} if \var{inst} is of type \var{cls}. If \var{inst} is not a
! class instance and \var{cls} is neither a type object or class
! object, \var{inst} must have a \member{__class__} attribute --- the
! class relationship of the value of that attribute with \var{cls}
! will be used to determine the result of this function.
\versionadded{2.1}
\end{cfuncdesc}
--- 130,142 ----

\begin{cfuncdesc}{int}{PyObject_IsInstance}{PyObject *inst, PyObject *cls}
! Returns \code{1} if \var{inst} is an instance of the class \var{cls}
! or a subclass of \var{cls}, or \code{0} if not. On error, returns
! \code{-1} and sets an exception. If \var{cls} is a type object
! rather than a class object, \cfunction{PyObject_IsInstance()}
! returns \code{1} if \var{inst} is of type \var{cls}. If \var{inst}
! is not a class instance and \var{cls} is neither a type object or
! class object, \var{inst} must have a \member{__class__} attribute
! --- the class relationship of the value of that attribute with
! \var{cls} will be used to determine the result of this function.
\versionadded{2.1}
\end{cfuncdesc}