Skip to content

Commit 27d9ed2

Browse files
committed
doc: Improve C API manual for complex number objects
1 parent 1414d2a commit 27d9ed2

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

Doc/c-api/complex.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Complex Number Objects
5757
not defined then it falls back to call :c:func:`PyFloat_AsDouble` and
5858
returns its result.
5959
60-
Upon failure, this method returns ``-1.0`` with an exception set, so one
60+
Upon failure, this function returns ``-1.0`` with an exception set, so one
6161
should call :c:func:`PyErr_Occurred` to check for errors.
6262
6363
.. versionchanged:: 3.13
@@ -73,7 +73,7 @@ Complex Number Objects
7373
not defined then it falls back to call :c:func:`PyFloat_AsDouble` and
7474
returns ``0.0`` on success.
7575
76-
Upon failure, this method returns ``-1.0`` with an exception set, so one
76+
Upon failure, this function returns ``-1.0`` with an exception set, so one
7777
should call :c:func:`PyErr_Occurred` to check for errors.
7878
7979
.. versionchanged:: 3.13
@@ -112,7 +112,7 @@ Complex Number Objects
112112
:meth:`~object.__float__`. If :meth:`!__float__` is not defined then it falls back
113113
to :meth:`~object.__index__`.
114114
115-
Upon failure, this method returns :c:type:`Py_complex`
115+
Upon failure, this function returns :c:type:`Py_complex`
116116
with :c:member:`~Py_complex.real` set to ``-1.0`` and with an exception set, so one
117117
should call :c:func:`PyErr_Occurred` to check for errors.
118118
@@ -171,7 +171,7 @@ the :ref:`Number Protocol <number>` API or use native complex types, like
171171
Return the quotient of two complex numbers, using the C :c:type:`Py_complex`
172172
representation.
173173
174-
If *divisor* is null, this method returns zero and sets
174+
If *divisor* is zero, this function returns zero and sets
175175
:c:data:`errno` to :c:macro:`!EDOM`.
176176
177177
.. deprecated:: 3.15
@@ -182,10 +182,11 @@ the :ref:`Number Protocol <number>` API or use native complex types, like
182182
Return the exponentiation of *num* by *exp*, using the C :c:type:`Py_complex`
183183
representation.
184184
185-
If *num* is null and *exp* is not a positive real number,
186-
this method returns zero and sets :c:data:`errno` to :c:macro:`!EDOM`.
185+
If *exp* is zero, this function returns ``{1.0, 0.0}``; otherwise
186+
if *num* is zero and *exp* is not a positive real number,
187+
this function returns zero and sets :c:data:`errno` to :c:macro:`!EDOM`.
187188
188-
Set :c:data:`errno` to :c:macro:`!ERANGE` on overflows.
189+
On overflow, this function sets :c:data:`errno` to :c:macro:`!ERANGE`.
189190
190191
.. deprecated:: 3.15
191192
@@ -194,6 +195,6 @@ the :ref:`Number Protocol <number>` API or use native complex types, like
194195
195196
Return the absolute value of the complex number *num*.
196197
197-
Set :c:data:`errno` to :c:macro:`!ERANGE` on overflows.
198+
On overflow, this function sets :c:data:`errno` to :c:macro:`!ERANGE`.
198199
199200
.. deprecated:: 3.15

0 commit comments

Comments
 (0)