From: Eli Bendersky <eliben@gmail.com>
Date: Sat, 15 Jan 2011 10:23:34 +0000 (+0000)
Subject: Issue #10912: Clarify the documentation of PyObject_RichCompareBool. Thanks to Devin... 
X-Git-Tag: v3.2rc1~16
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ad30c4206af997f8c94c4e62a3e66abfa633442b;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 8410934423fa..afa08c9bc3c8 100644
--- 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)