https://github.com/python/cpython/commit/926881dc10ebf77069e02e66eea3e0d3ba500fe5
commit: 926881dc10ebf77069e02e66eea3e0d3ba500fe5
branch: main
author: Sergey B Kirpichev <[email protected]>
committer: serhiy-storchaka <[email protected]>
date: 2024-01-27T09:55:33+02:00
summary:
gh-113445: Amend PyObject_RichCompareBool() docs (GH-113891)
files:
M Doc/c-api/object.rst
diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 4f656779c80b1a..12476412799a4f 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`
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
