diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2019-05-17 09:59:14 (GMT) |
|---|---|---|
| committer | Kushal Das <mail@kushaldas.in> | 2019-05-17 09:59:13 (GMT) |
| commit | 6faad355db6c2bd4a0ade7868f245b42c04f5337 (patch) | |
| tree | 1de46713251d89736e43d960ed21f3fbf9a24e59 /Doc | |
| parent | cbb6484573ae2058e55614b28d73b0c8478f9a70 (diff) | |
| download | cpython-6faad355db6c2bd4a0ade7868f245b42c04f5337.zip cpython-6faad355db6c2bd4a0ade7868f245b42c04f5337.tar.gz cpython-6faad355db6c2bd4a0ade7868f245b42c04f5337.tar.bz2 | |
bpo-36908: 'This module is always available' isn't helpful. (#13297)
Makes the documentation of math and cmath module
more helpful for the beginners.
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/cmath.rst | 13 | ||||
| -rw-r--r-- | Doc/library/math.rst | 4 |
2 files changed, 8 insertions, 9 deletions
diff --git a/Doc/library/cmath.rst b/Doc/library/cmath.rst index 9d81730..28cd96b 100644 --- a/Doc/library/cmath.rst +++ b/Doc/library/cmath.rst @@ -6,13 +6,12 @@ -------------- -This module is always available. It provides access to mathematical functions -for complex numbers. The functions in this module accept integers, -floating-point numbers or complex numbers as arguments. They will also accept -any Python object that has either a :meth:`__complex__` or a :meth:`__float__` -method: these methods are used to convert the object to a complex or -floating-point number, respectively, and the function is then applied to the -result of the conversion. +This module provides access to mathematical functions for complex numbers. The +functions in this module accept integers, floating-point numbers or complex +numbers as arguments. They will also accept any Python object that has either a +:meth:`__complex__` or a :meth:`__float__` method: these methods are used to +convert the object to a complex or floating-point number, respectively, and +the function is then applied to the result of the conversion. .. note:: diff --git a/Doc/library/math.rst b/Doc/library/math.rst index 7129525..49f932d 100644 --- a/Doc/library/math.rst +++ b/Doc/library/math.rst @@ -10,8 +10,8 @@ -------------- -This module is always available. It provides access to the mathematical -functions defined by the C standard. +This module provides access to the mathematical functions defined by the C +standard. These functions cannot be used with complex numbers; use the functions of the same name from the :mod:`cmath` module if you require support for complex |