diff options
| author | Antoine Pitrou <solipsis@pitrou.net> | 2011-12-18 00:25:27 (GMT) |
|---|---|---|
| committer | Antoine Pitrou <solipsis@pitrou.net> | 2011-12-18 00:25:27 (GMT) |
| commit | c9e180043cdecc78bc602ef1c055a8c097a4648b (patch) | |
| tree | b4b6dce47caf65d5179dc3d87ab2e85b30e283a7 /Doc/c-api | |
| parent | 13c82d00c4c615730df5055f300ad6d0971d16d8 (diff) | |
| download | cpython-c9e180043cdecc78bc602ef1c055a8c097a4648b.zip cpython-c9e180043cdecc78bc602ef1c055a8c097a4648b.tar.gz cpython-c9e180043cdecc78bc602ef1c055a8c097a4648b.tar.bz2 | |
Issue #13522: document error return values of some float and complex C API functions.
Diffstat (limited to 'Doc/c-api')
| -rw-r--r-- | Doc/c-api/complex.rst | 7 | ||||
| -rw-r--r-- | Doc/c-api/float.rst | 2 |
2 files changed, 9 insertions, 0 deletions
diff --git a/Doc/c-api/complex.rst b/Doc/c-api/complex.rst index 364ab78..f5304bd 100644 --- a/Doc/c-api/complex.rst +++ b/Doc/c-api/complex.rst @@ -63,12 +63,18 @@ pointers. This is consistent throughout the API. Return the quotient of two complex numbers, using the C :ctype:`Py_complex` representation. + If *divisor* is null, this method returns zero and sets + :cdata:`errno` to :cdata:`EDOM`. + .. cfunction:: Py_complex _Py_c_pow(Py_complex num, Py_complex exp) Return the exponentiation of *num* by *exp*, using the C :ctype:`Py_complex` representation. + If :attr:`exp.imag` is not null, or :attr:`exp.real` is negative, + this method returns zero and sets :cdata:`errno` to :cdata:`EDOM`. + Complex Numbers as Python Objects ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -125,6 +131,7 @@ Complex Numbers as Python Objects .. cfunction:: Py_complex PyComplex_AsCComplex(PyObject *op) Return the :ctype:`Py_complex` value of the complex number *op*. + Upon failure, this method returns ``-1.0`` as a real value. .. versionchanged:: 2.6 If *op* is not a Python complex number object but has a :meth:`__complex__` diff --git a/Doc/c-api/float.rst b/Doc/c-api/float.rst index 295fb90..d92f155 100644 --- a/Doc/c-api/float.rst +++ b/Doc/c-api/float.rst @@ -55,6 +55,8 @@ Floating Point Objects Return a C :ctype:`double` representation of the contents of *pyfloat*. If *pyfloat* is not a Python floating point object but has a :meth:`__float__` method, this method will first be called to convert *pyfloat* into a float. + This method returns ``-1.0`` upon failure, so one should call + :cfunc:`PyErr_Occurred` to check for errors. .. cfunction:: double PyFloat_AS_DOUBLE(PyObject *pyfloat) |