languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-09-15 23:36:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

bpo-36908: 'This module is always available' isn't helpful. (#13297)

Browse source 
Makes the documentation of math and cmath module
more helpful for the beginners.
This commit is contained in:
Ned Batchelder 2019-05-17 05:59:14 -04:00 committed by Kushal Das
parent cbb6484573
commit 6faad355db
4 changed files with 12 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
Doc/library/cmath.rst
View file

@ -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::

4
Doc/library/math.rst
View file

@ -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

4
Modules/cmathmodule.c
View file

@ -1232,8 +1232,8 @@ cmath_isclose_impl(PyObject *module, Py_complex a, Py_complex b,
}
PyDoc_STRVAR(module_doc,
"This module is always available. It provides access to mathematical\n"
"functions for complex numbers.");
"This module provides access to mathematical functions for complex\n"
"numbers.");
static PyMethodDef cmath_methods[] = {
CMATH_ACOS_METHODDEF

4
Modules/mathmodule.c
View file

@ -2759,8 +2759,8 @@ static PyMethodDef math_methods[] = {
PyDoc_STRVAR(module_doc,
"This module is always available. It provides access to the\n"
"mathematical functions defined by the C standard.");
"This module provides access to the mathematical functions\n"
"defined by the C standard.");
static struct PyModuleDef mathmodule = {