diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2024-01-27 08:02:34 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-27 08:02:34 (GMT) |
| commit | a3953cb9af70c5ea7a3c3ddd4385d8d307b51897 (patch) | |
| tree | e852ce969a5262c7aa415f0c125fbc8cfa228345 | |
| parent | dfef41a1d6ae4a869f72cceea136b881e7a27c41 (diff) | |
| download | cpython-a3953cb9af70c5ea7a3c3ddd4385d8d307b51897.zip cpython-a3953cb9af70c5ea7a3c3ddd4385d8d307b51897.tar.gz cpython-a3953cb9af70c5ea7a3c3ddd4385d8d307b51897.tar.bz2 | |
[3.11] gh-113445: Amend PyObject_RichCompareBool() docs (GH-113891) (GH-114637)
(cherry picked from commit 926881dc10ebf77069e02e66eea3e0d3ba500fe5)
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
| -rw-r--r-- | Doc/c-api/object.rst | 8 |
1 files changed, 2 insertions, 6 deletions
diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst index 32f74fb..e3a0aaa 100644 --- a/Doc/c-api/object.rst +++ b/Doc/c-api/object.rst @@ -180,12 +180,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` |