]> granicus.if.org Git - python/commitdiff
Add missing doc for Py_True/Py_False. Use the correct macro to define
authorSkip Montanaro <skip@pobox.com>
Thu, 29 Jul 2004 02:16:04 +0000 (02:16 +0000)
committerSkip Montanaro <skip@pobox.com>
Thu, 29 Jul 2004 02:16:04 +0000 (02:16 +0000)
Py_RETURN_FALSE and Py_RETURN_TRUE.

Doc/api/concrete.tex

index 992442dc28682ff1a440a81cb89477bc6253a3d1..a9246ac57b7ce0154a4dad71a3cd2408c0e41220 100644 (file)
@@ -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}.