mirror of
				https://github.com/python/cpython.git
				synced 2025-10-31 02:15:10 +00:00 
			
		
		
		
	Issue #13522: document error return values of some float and complex C API functions.
This commit is contained in:
		
						commit
						b511aca596
					
				
					 3 changed files with 10 additions and 1 deletions
				
			
		|  | @ -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. | ||||
|  |  | |||
|  | @ -47,6 +47,8 @@ Floating Point Objects | |||
|    Return a C :c:type:`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 | ||||
|    :c:func:`PyErr_Occurred` to check for errors. | ||||
| 
 | ||||
| 
 | ||||
| .. c:function:: double PyFloat_AS_DOUBLE(PyObject *pyfloat) | ||||
|  |  | |||
|  | @ -149,6 +149,7 @@ Lee Busby | |||
| Ralph Butler | ||||
| Nicolas Cadou | ||||
| Jp Calderone | ||||
| Arnaud Calmettes | ||||
| Daniel Calvelo | ||||
| Tony Campbell | ||||
| Brett Cannon | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 Antoine Pitrou
						Antoine Pitrou