From a0c5e9fb745ce0491b56c537c78ccfa598c879a5 Mon Sep 17 00:00:00 2001
From: Fred Drake <fdrake@acm.org>
Date: Fri, 14 Jun 2002 14:35:56 +0000
Subject: [PATCH] Clean up descriptions of PyObject_RichCompare() and
 PyObject_RichCompareBool() based on comments from David Abrahams. Added
 refcount information for these functions.

---
 Doc/api/abstract.tex  | 16 ++++++++--------
 Doc/api/refcounts.dat | 10 ++++++++++
 2 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/Doc/api/abstract.tex b/Doc/api/abstract.tex
index 24de2f103cf..d27e383e9c6 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}
diff --git a/Doc/api/refcounts.dat b/Doc/api/refcounts.dat
index 5128f8f027e..dcc66bc7fb7 100644
--- a/Doc/api/refcounts.dat
+++ b/Doc/api/refcounts.dat
@@ -843,6 +843,16 @@ PyObject_Print:int:flags::
 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: