mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 00:48:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Issue #13522: document error return values of some float and complex C API functions.

Browse source
This commit is contained in:
Antoine Pitrou 2011-12-18 01:25:27 +01:00
parent bb2e9c477d
commit 07b1c877b2
3 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Doc/c-api/complex.rst
View file

@ -63,12 +63,18 @@ pointers. This is consistent throughout the API.
Return the quotient of two complex numbers, using the C :c:type:`Py_complex`
representation.
If *divisor* is null, this method returns zero and sets
:c:data:`errno` to :c:data:`EDOM`.
.. c:function:: Py_complex _Py_c_pow(Py_complex num, Py_complex exp)
Return the exponentiation of *num* by *exp*, using the C :c:type:`Py_complex`
representation.
If :attr:`exp.imag` is not null, or :attr:`exp.real` is negative,
this method returns zero and sets :c:data:`errno` to :c:data:`EDOM`.
Complex Numbers as Python Objects
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -123,4 +129,4 @@ Complex Numbers as Python Objects
If *op* is not a Python complex number object but has a :meth:`__complex__`
method, this method will first be called to convert *op* to a Python complex
number object.
number object. Upon failure, this method returns ``-1.0`` as a real value.