Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Update docs about tp_richcompare

This commit is contained in:
Andrew Svetlov 2014-07-03 16:07:17 +03:00
parent 11cda47661
commit 0d50af45b6
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Doc/c-api/typeobj.rst
View File

@ -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