diff options
author | Skip Montanaro <skip@pobox.com> | 2004-07-29 02:16:04 (GMT) |
---|---|---|
committer | Skip Montanaro <skip@pobox.com> | 2004-07-29 02:16:04 (GMT) |
commit | 6d3db7000ee8f3a910e101bb5f622463af2b2b31 (patch) | |
tree | 3eef7e4872e7c3b09b37c70f44177de377df3396 /Doc/api | |
parent | a18331de4e513653e3c2001be07f5df034abd4ba (diff) | |
download | cpython-6d3db7000ee8f3a910e101bb5f622463af2b2b31.zip cpython-6d3db7000ee8f3a910e101bb5f622463af2b2b31.tar.gz cpython-6d3db7000ee8f3a910e101bb5f622463af2b2b31.tar.bz2 |
Add missing doc for Py_True/Py_False. Use the correct macro to define
Py_RETURN_FALSE and Py_RETURN_TRUE.
Diffstat (limited to 'Doc/api')
-rw-r--r-- | Doc/api/concrete.tex | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex index 992442d..a9246ac 100644 --- a/Doc/api/concrete.tex +++ b/Doc/api/concrete.tex @@ -204,17 +204,27 @@ booleans. The following macros are available, however. \versionadded{2.3} \end{cfuncdesc} -\begin{cfuncdesc}{Py_RETURN_FALSE} -Return Py_False from a function, properly incrementing its reference -count. +\begin{cvardesc}{PyObject*}{Py_False} + The Python \code{False} object. This object has no methods. It needs to + be treated just like any other object with respect to reference counts. +\end{cvardesc} + +\begin{cvardesc}{PyObject*}{Py_True} + The Python \code{True} object. This object has no methods. It needs to + be treated just like any other object with respect to reference counts. +\end{cvardesc} + +\begin{csimplemacrodesc}{Py_RETURN_FALSE} + Return \constant{Py_False} from a function, properly incrementing its + reference count. \versionadded{2.4} -\end{cfuncdesc} +\end{csimplemacrodesc} -\begin{cfuncdesc}{Py_RETURN_TRUE} +\begin{csimplemacrodesc}{Py_RETURN_TRUE} Return Py_True from a function, properly incrementing its reference count. \versionadded{2.4} -\end{cfuncdesc} +\end{csimplemacrodesc} \begin{cfuncdesc}{int}{PyBool_Check}{PyObject* o} Returns true if \var{o} is of type \cdata{PyBool_Type}. |