summaryrefslogtreecommitdiffstats
path: root/Include
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1996-09-06 13:40:53 (GMT)
committerGuido van Rossum <guido@python.org>1996-09-06 13:40:53 (GMT)
commited227f0589e3a84eef48ca93616c6c178671d36d (patch)
treebb05b21241bc08b16a993df40544d0dc37693596 /Include
parentcac6c721057d84ebfda870be61aa318819eb4267 (diff)
downloadcpython-ed227f0589e3a84eef48ca93616c6c178671d36d.zip
cpython-ed227f0589e3a84eef48ca93616c6c178671d36d.tar.gz
cpython-ed227f0589e3a84eef48ca93616c6c178671d36d.tar.bz2
Correctly document PyNumber_Coerce.
Diffstat (limited to 'Include')
-rw-r--r--Include/abstract.h20
1 files changed, 14 insertions, 6 deletions
diff --git a/Include/abstract.h b/Include/abstract.h
index 956ca89..a397c47 100644
--- a/Include/abstract.h
+++ b/Include/abstract.h
@@ -580,12 +580,20 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/
/* Implemented elsewhere:
- int PyNumber_Coerce(PyObject *o1, PyObject *o2);
-
- On success, returns a tuple containing o1 and o2 converted to
- a common numeric type, or None if no conversion is possible.
- Returns -1 on failure. This is equivalent to the Python
- expression: coerce(o1,o2).
+ int PyNumber_Coerce(PyObject **p1, PyObject **p2);
+
+ This function takes the addresses of two variables of type
+ PyObject*.
+
+ If the objects pointed to by *p1 and *p2 have the same type,
+ increment their reference count and return 0 (success).
+ If the objects can be converted to a common numeric type,
+ replace *p1 and *p2 by their converted value (with 'new'
+ reference counts), and return 0.
+ If no conversion is possible, or if some other error occurs,
+ return -1 (failure) and don't increment the reference counts.
+ The call PyNumber_Coerce(&o1, &o2) is equivalent to the Python
+ statement o1, o2 = coerce(o1, o2).
*/