[Python-checkins] r46252 - python/trunk/Doc/api/newtypes.tex

[georg.brandl]

Author: georg.brandl
Date: Thu May 25 22:28:10 2006
New Revision: 46252

Modified:
   python/trunk/Doc/api/newtypes.tex
Log:
Someone seems to just have copy-pasted the docs of
tp_compare to tp_richcompare ;)



Modified: python/trunk/Doc/api/newtypes.tex
==============================================================================
--- python/trunk/Doc/api/newtypes.tex	(original)
+++ python/trunk/Doc/api/newtypes.tex	Thu May 25 22:28:10 2006
@@ -990,10 +990,10 @@
   An optional pointer to the rich comparison function.
 
   The signature is the same as for \cfunction{PyObject_RichCompare()}.
-  The function should return \code{1} if the requested comparison
-  returns true, \code{0} if it returns false.  It should return
-  \code{-1} and set an exception condition when an error occurred
-  during the comparison.
+  The function should return the result of the comparison (usually
+  \code{Py_True} or \code{Py_False}).  If the comparison is undefined,
+  it must return \code{Py_NotImplemented}, if another error occurred
+  it must return \code{NULL} and set an exception condition.
 
   This field is inherited by subtypes together with
   \member{tp_compare} and \member{tp_hash}: a subtype inherits all