diff options
author | Fred Drake <fdrake@acm.org> | 2002-06-14 14:35:56 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2002-06-14 14:35:56 (GMT) |
commit | a0c5e9fb745ce0491b56c537c78ccfa598c879a5 (patch) | |
tree | 1cb3a927ce9311dd16e9dd801575b7cf20d867a3 /Doc/api/abstract.tex | |
parent | da07ea72826b6b3b9249d664d1c22a10eefe5460 (diff) | |
download | cpython-a0c5e9fb745ce0491b56c537c78ccfa598c879a5.zip cpython-a0c5e9fb745ce0491b56c537c78ccfa598c879a5.tar.gz cpython-a0c5e9fb745ce0491b56c537c78ccfa598c879a5.tar.bz2 |
Clean up descriptions of PyObject_RichCompare() and PyObject_RichCompareBool()
based on comments from David Abrahams.
Added refcount information for these functions.
Diffstat (limited to 'Doc/api/abstract.tex')
-rw-r--r-- | Doc/api/abstract.tex | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/Doc/api/abstract.tex b/Doc/api/abstract.tex index 24de2f1..d27e383 100644 --- a/Doc/api/abstract.tex +++ b/Doc/api/abstract.tex @@ -82,9 +82,9 @@ for which they do not apply, they will raise a Python exception. \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 - specified by \var{op}, which must be one of + specified by \var{opid}, which must be one of \constant{Py_LT}, \constant{Py_LE}, \constant{Py_EQ}, @@ -97,15 +97,15 @@ for which they do not apply, they will raise a Python exception. \code{!=}, \code{>}, or \code{>=} respectively. This is the equivalent of the Python expression - \samp{\var{o1} \emph{op} \var{o2}}, where \emph{op} is the operator - corresponding to \var{op}. Returns the value of the comparison on + \samp{\var{o1} op \var{o2}}, where \code{op} is the operator + corresponding to \var{opid}. Returns the value of the comparison on success, or \NULL{} on failure. \end{cfuncdesc} \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 - specified by \var{op}, which must be one of + specified by \var{opid}, which must be one of \constant{Py_LT}, \constant{Py_LE}, \constant{Py_EQ}, @@ -119,8 +119,8 @@ for which they do not apply, they will raise a Python exception. \code{>}, or \code{>=} respectively. Returns \code{-1} on error, \code{0} if the result is false, \code{1} otherwise. This is the equivalent of the - Python expression \samp{\var{o1} \emph{op} \var{o2}}, where - \emph{op} is the operator corresponding to \var{op}. + Python expression \samp{\var{o1} op \var{o2}}, where + \code{op} is the operator corresponding to \var{opid}. \end{cfuncdesc} \begin{cfuncdesc}{int}{PyObject_Cmp}{PyObject *o1, PyObject *o2, int *result} |