Issue #10912: Clarify the documentation of PyObject_RichCompareBool. Thanks to Devin Jeanpierre for spotting the problem.

eliben · eliben · commit ad30c4206af9 · 2011-01-15T10:23:34.000Z
diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
@@ -108,6 +108,9 @@ Object Protocol
    Python expression ``o1 op o2``, where ``op`` is the operator corresponding to
    *opid*.
 
+.. note::
+   If *o1* and *o2* are the same object, :c:func:`PyObject_RichCompareBool`
+   will always return ``1`` for :const:`Py_EQ` and ``0`` for :const:`Py_NE`.
 
 .. c:function:: PyObject* PyObject_Repr(PyObject *o)
 
