Clean up descriptions of PyObject_RichCompare() and PyObject_RichCompareBool()
based on comments from David Abrahams.
Added refcount information for these functions.
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 @@
\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 @@
\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 @@
\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}
diff --git a/Doc/api/refcounts.dat b/Doc/api/refcounts.dat
index 5128f8f..dcc66bc 100644
--- a/Doc/api/refcounts.dat
+++ b/Doc/api/refcounts.dat
@@ -843,6 +843,16 @@
PyObject_Repr:PyObject*::+1:
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:PyObject*:o:0:
PyObject_SetAttr:PyObject*:attr_name:0: