From: Sergey B Kirpichev <skirpichev@gmail.com>
Date: Sat, 27 Jan 2024 07:55:33 +0000 (+0300)
Subject: gh-113445: Amend PyObject_RichCompareBool() docs (GH-113891)
X-Git-Tag: v3.13.0a4~299
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=926881dc10ebf77069e02e66eea3e0d3ba500fe5;p=thirdparty%2FPython%2Fcpython.git

gh-113445: Amend PyObject_RichCompareBool() docs (GH-113891)
---

diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 4f656779c80b..12476412799a 100644
--- a/Doc/c-api/object.rst
+++ b/Doc/c-api/object.rst
@@ -229,12 +229,8 @@ Object Protocol
 .. c:function:: int PyObject_RichCompareBool(PyObject *o1, PyObject *o2, int opid)
 
    Compare the values of *o1* and *o2* using the operation specified by *opid*,
-   which must be one of :c:macro:`Py_LT`, :c:macro:`Py_LE`, :c:macro:`Py_EQ`,
-   :c:macro:`Py_NE`, :c:macro:`Py_GT`, or :c:macro:`Py_GE`, corresponding to ``<``,
-   ``<=``, ``==``, ``!=``, ``>``, or ``>=`` respectively. Returns ``-1`` on error,
-   ``0`` if the result is false, ``1`` otherwise. This is the equivalent of the
-   Python expression ``o1 op o2``, where ``op`` is the operator corresponding to
-   *opid*.
+   like :c:func:`PyObject_RichCompare`, but returns ``-1`` on error, ``0`` if
+   the result is false, ``1`` otherwise.
 
 .. note::
    If *o1* and *o2* are the same object, :c:func:`PyObject_RichCompareBool`