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 b0700a141904c5f06e9255be6c3963fc690d7045..c084860e90333abba8e90e4a7b5a4491f596dee1 100644 (file)
--- 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)