summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2003-04-16 17:30:15 +0000
committerRaymond Hettinger <python@rcn.com>2003-04-16 17:30:15 +0000
commitb4d53fda5b508713e2e4c90d6900325453fbc2c2 (patch)
tree627bcf4fd6389d1c82d98d705a2c3c19b4aea07f /Doc
parent9976fdf83cd75816e2d370197f030074c6cc1697 (diff)
downloadcpython-git-b4d53fda5b508713e2e4c90d6900325453fbc2c2.tar.gz
As discussed on python-dev, revised docs to note that
PyObject_IsTrue() can have an error result. Also, added missing docs for PyObject_Not().
Diffstat (limited to 'Doc')
-rw-r--r--Doc/api/abstract.tex9
1 files changed, 8 insertions, 1 deletions
diff --git a/Doc/api/abstract.tex b/Doc/api/abstract.tex
index ee26a27eae..5d9491099a 100644
--- a/Doc/api/abstract.tex
+++ b/Doc/api/abstract.tex
@@ -289,7 +289,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}