From: Eli Bendersky <eliben@gmail.com>
Date: Sat, 15 Jan 2011 10:33:07 +0000 (+0000)
Subject: Merged revisions 88009 via svnmerge from
X-Git-Tag: v3.2.1b1~347^2~65
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=5bcc563cdeacff962635e34c6f642abeacc05929;p=thirdparty%2FPython%2Fcpython.git

Merged revisions 88009 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r88009 | eli.bendersky | 2011-01-15 12:23:34 +0200 (Sat, 15 Jan 2011) | 2 lines

  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 b0700a141904..c084860e9033 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`.
 
 .. cfunction:: PyObject* PyObject_Repr(PyObject *o)