[Python-checkins] python/dist/src/Doc/api api.tex,1.117.2.14,1.117.2.15

[fdrake@users.sourceforge.net]

Update of /cvsroot/python/python/dist/src/Doc/api
In directory usw-pr-cvs1:/tmp/cvs-serv20057/api

Modified Files:
      Tag: release21-maint
	api.tex 
Log Message:
Add documentation for PyObject_RichCompare() and PyObject_RichCompareBool(),
constributed by David Abrahams.
This closes SF patch #568081.


Index: api.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/api.tex,v
retrieving revision 1.117.2.14
retrieving revision 1.117.2.15
diff -C2 -d -r1.117.2.14 -r1.117.2.15
*** api.tex	10 Apr 2002 18:16:32 -0000	1.117.2.14
--- api.tex	13 Jun 2002 11:53:54 -0000	1.117.2.15
***************
*** 1478,1481 ****
--- 1478,1523 ----
  
  
+ \begin{cfuncdesc}{PyObject*}{PyObject_RichCompare}{PyObject *o1,
+                                                    PyObject *o2, int op}
+   Compare the values of \var{o1} and \var{o2} using the operation
+   specified by \var{op}, which must be one of 
+   \constant{Py_LT},
+   \constant{Py_LE},
+   \constant{Py_EQ},
+   \constant{Py_NE},
+   \constant{Py_GT}, or
+   \constant{Py_GE}, corresponding to
+   \code{<},
+   \code{<=},
+   \code{==},
+   \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
+   success, or \NULL{} on failure.
+ \end{cfuncdesc}
+ 
+ \begin{cfuncdesc}{int}{PyObject_RichCompareBool}{PyObject *o1,
+                                                  PyObject *o2, int op}
+   Compare the values of \var{o1} and \var{o2} using the operation
+   specified by \var{op}, which must be one of 
+   \constant{Py_LT},
+   \constant{Py_LE},
+   \constant{Py_EQ},
+   \constant{Py_NE},
+   \constant{Py_GT}, or
+   \constant{Py_GE}, corresponding to
+   \code{<},
+   \code{<=},
+   \code{==},
+   \code{!=},
+   \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}.
+ \end{cfuncdesc}
+ 
  \begin{cfuncdesc}{int}{PyObject_Cmp}{PyObject *o1, PyObject *o2, int *result}
  Compare the values of \var{o1} and \var{o2} using a routine provided