diff options
author | Raymond Hettinger <python@rcn.com> | 2003-04-16 17:28:12 (GMT) |
---|---|---|
committer | Raymond Hettinger <python@rcn.com> | 2003-04-16 17:28:12 (GMT) |
commit | 2ed6dff796285efb7468e2c2c0fb817ed25b889c (patch) | |
tree | 52a9987b3d532c687b5f45160e82c4e93491394c /Doc/api | |
parent | 1475c4921198b92d24a01ad6a389bb9bf296375d (diff) | |
download | cpython-2ed6dff796285efb7468e2c2c0fb817ed25b889c.zip cpython-2ed6dff796285efb7468e2c2c0fb817ed25b889c.tar.gz cpython-2ed6dff796285efb7468e2c2c0fb817ed25b889c.tar.bz2 |
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.
Diffstat (limited to 'Doc/api')
-rw-r--r-- | Doc/api/abstract.tex | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/Doc/api/abstract.tex b/Doc/api/abstract.tex index 1d87c05..dd23768 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} |