From: Andrew Svetlov <andrew.svetlov@gmail.com>
Date: Thu, 3 Jul 2014 13:07:17 +0000 (+0300)
Subject: Update docs about tp_richcompare
X-Git-Tag: v3.4.2rc1~268
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0d50af45b654784fe639ab6489f91e7524ed3ace;p=python

Update docs about tp_richcompare
---

diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
index 3a64724641..497af23bdf 100644
--- a/Doc/c-api/typeobj.rst
+++ b/Doc/c-api/typeobj.rst
@@ -597,7 +597,9 @@ type objects) *must* have the :attr:`ob_size` field.
 .. c:member:: richcmpfunc PyTypeObject.tp_richcompare
 
    An optional pointer to the rich comparison function, whose signature is
-   ``PyObject *tp_richcompare(PyObject *a, PyObject *b, int op)``.
+   ``PyObject *tp_richcompare(PyObject *a, PyObject *b, int op)``. The first
+   parameter is guaranteed to be an instance of the type that is defined
+   by :c:type:`PyTypeObject`.
 
    The function should return the result of the comparison (usually ``Py_True``
    or ``Py_False``).  If the comparison is undefined, it must return