Skip to content

Commit f27f867

Browse files
skirpichevGlyphack
authored andcommitted
pythongh-113445: Amend PyObject_RichCompareBool() docs (pythonGH-113891)
1 parent 40ff495 commit f27f867

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

Doc/c-api/object.rst

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -229,12 +229,8 @@ Object Protocol
229229
.. c:function:: int PyObject_RichCompareBool(PyObject *o1, PyObject *o2, int opid)
230230
231231
Compare the values of *o1* and *o2* using the operation specified by *opid*,
232-
which must be one of :c:macro:`Py_LT`, :c:macro:`Py_LE`, :c:macro:`Py_EQ`,
233-
:c:macro:`Py_NE`, :c:macro:`Py_GT`, or :c:macro:`Py_GE`, corresponding to ``<``,
234-
``<=``, ``==``, ``!=``, ``>``, or ``>=`` respectively. Returns ``-1`` on error,
235-
``0`` if the result is false, ``1`` otherwise. This is the equivalent of the
236-
Python expression ``o1 op o2``, where ``op`` is the operator corresponding to
237-
*opid*.
232+
like :c:func:`PyObject_RichCompare`, but returns ``-1`` on error, ``0`` if
233+
the result is false, ``1`` otherwise.
238234
239235
.. note::
240236
If *o1* and *o2* are the same object, :c:func:`PyObject_RichCompareBool`

0 commit comments

Comments
 (0)