traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clean up descriptions of PyObject_RichCompare() and PyObject_RichCompareBool() 

based on comments from David Abrahams.
Added refcount information for these functions.
This commit is contained in:
Fred Drake 2002-06-14 14:35:56 +00:00
parent da07ea7282
commit a0c5e9fb74
2 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Doc/api/abstract.tex
View File

@ -82,9 +82,9 @@ for which they do not apply, they will raise a Python exception.
\begin{cfuncdesc}{PyObject*}{PyObject_RichCompare}{PyObject *o1, \begin{cfuncdesc}{PyObject*}{PyObject_RichCompare}{PyObject *o1,
PyObject *o2, int op} PyObject *o2, int opid}
Compare the values of \var{o1} and \var{o2} using the operation Compare the values of \var{o1} and \var{o2} using the operation
specified by \var{op}, which must be one of specified by \var{opid}, which must be one of
\constant{Py_LT}, \constant{Py_LT},
\constant{Py_LE}, \constant{Py_LE},
\constant{Py_EQ}, \constant{Py_EQ},
@ -97,15 +97,15 @@ for which they do not apply, they will raise a Python exception.
\code{!=}, \code{!=},
\code{>}, or \code{>}, or
\code{>=} respectively. This is the equivalent of the Python expression \code{>=} respectively. This is the equivalent of the Python expression
\samp{\var{o1} \emph{op} \var{o2}}, where \emph{op} is the operator \samp{\var{o1} op \var{o2}}, where \code{op} is the operator
corresponding to \var{op}. Returns the value of the comparison on corresponding to \var{opid}. Returns the value of the comparison on
success, or \NULL{} on failure. success, or \NULL{} on failure.
\end{cfuncdesc} \end{cfuncdesc}
\begin{cfuncdesc}{int}{PyObject_RichCompareBool}{PyObject *o1, \begin{cfuncdesc}{int}{PyObject_RichCompareBool}{PyObject *o1,
PyObject *o2, int op} PyObject *o2, int opid}
Compare the values of \var{o1} and \var{o2} using the operation Compare the values of \var{o1} and \var{o2} using the operation
specified by \var{op}, which must be one of specified by \var{opid}, which must be one of
\constant{Py_LT}, \constant{Py_LT},
\constant{Py_LE}, \constant{Py_LE},
\constant{Py_EQ}, \constant{Py_EQ},
@ -119,8 +119,8 @@ for which they do not apply, they will raise a Python exception.
\code{>}, or \code{>}, or
\code{>=} respectively. Returns \code{-1} on error, \code{0} if the \code{>=} respectively. Returns \code{-1} on error, \code{0} if the
result is false, \code{1} otherwise. This is the equivalent of the result is false, \code{1} otherwise. This is the equivalent of the
Python expression \samp{\var{o1} \emph{op} \var{o2}}, where Python expression \samp{\var{o1} op \var{o2}}, where
\emph{op} is the operator corresponding to \var{op}. \code{op} is the operator corresponding to \var{opid}.
\end{cfuncdesc} \end{cfuncdesc}
\begin{cfuncdesc}{int}{PyObject_Cmp}{PyObject *o1, PyObject *o2, int *result} \begin{cfuncdesc}{int}{PyObject_Cmp}{PyObject *o1, PyObject *o2, int *result}

10
Doc/api/refcounts.dat
View File

@ -843,6 +843,16 @@ PyObject_Print:int:flags::
PyObject_Repr:PyObject*::+1: PyObject_Repr:PyObject*::+1:
PyObject_Repr:PyObject*:o:0: PyObject_Repr:PyObject*:o:0:
PyObject_RichCompare:PyObject*::+1:
PyObject_RichCompare:PyObject*:o1:0:
PyObject_RichCompare:PyObject*:o2:0:
PyObject_RichCompare:int:opid::
PyObject_RichCompareBool:int:::
PyObject_RichCompareBool:PyObject*:o1:0:
PyObject_RichCompareBool:PyObject*:o2:0:
PyObject_RichCompareBool:int:opid::
PyObject_SetAttr:int::: PyObject_SetAttr:int:::
PyObject_SetAttr:PyObject*:o:0: PyObject_SetAttr:PyObject*:o:0:
PyObject_SetAttr:PyObject*:attr_name:0: PyObject_SetAttr:PyObject*:attr_name:0: