From: Raymond Hettinger Date: Wed, 16 Apr 2003 17:28:12 +0000 (+0000) Subject: As discussed on python-dev, revised docs to note that X-Git-Tag: v2.3c1~1167 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2ed6dff796285efb7468e2c2c0fb817ed25b889c;p=thirdparty%2FPython%2Fcpython.git As discussed on python-dev, revised docs to note that PyObject_IsTrue() can have an error result. Also, added missing docs for PyObject_Not(). Will backport. --- diff --git a/Doc/api/abstract.tex b/Doc/api/abstract.tex index 1d87c0562b96..dd237683f6a4 100644 --- a/Doc/api/abstract.tex +++ b/Doc/api/abstract.tex @@ -310,7 +310,14 @@ determination. \begin{cfuncdesc}{int}{PyObject_IsTrue}{PyObject *o} Returns \code{1} if the object \var{o} is considered to be true, and \code{0} otherwise. This is equivalent to the Python expression - \samp{not not \var{o}}. This function always succeeds. + \samp{not not \var{o}}. On failure, return \code{-1}. +\end{cfuncdesc} + + +\begin{cfuncdesc}{int}{PyObject_Not}{PyObject *o} + Returns \code{0} if the object \var{o} is considered to be true, and + \code{1} otherwise. This is equivalent to the Python expression + \samp{not \var{o}}. On failure, return \code{-1}. \end{cfuncdesc}