Skip to content

gh-113445: amend PyObject_RichCompareBool() docs #113891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 27, 2024
Merged

gh-113445: amend PyObject_RichCompareBool() docs #113891

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3caa644
gh-113445: amend PyObject_RichCompareBool() docs
skirpichev Jan 10, 2024
f939451
Merge branch 'master' into 113445-PyObject_RichCompareBool
skirpichev Jan 27, 2024
499eefd
Address review: reference to PyObject_RichCompare
skirpichev Jan 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions Doc/c-api/object.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,12 +221,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`
Expand Down