[Python-checkins] cpython (3.4): Update docs about tp_richcompare
andrew.svetlov
python-checkins at python.org
Thu Jul 3 15:08:07 CEST 2014
http://hg.python.org/cpython/rev/71a0743f36db
changeset: 91534:71a0743f36db
branch: 3.4
parent: 91531:b28292359d4a
user: Andrew Svetlov <andrew.svetlov at gmail.com>
date: Thu Jul 03 16:07:17 2014 +0300
summary:
Update docs about tp_richcompare
files:
Doc/c-api/typeobj.rst | 4 +++-
1 files changed, 3 insertions(+), 1 deletions(-)
diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
--- a/Doc/c-api/typeobj.rst
+++ b/Doc/c-api/typeobj.rst
@@ -597,7 +597,9 @@
.. 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
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list