summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-05-17 14:08:21 -0700
committerGitHub <noreply@github.com>2019-05-17 14:08:21 -0700
commit740a7cde9c0af5a237a7f6525b38d65a83f4fbf1 (patch)
treebe602778e67cf72d574d401d4a30aa6541ef8f37
parent5386aaf07835889e90fb33e95b6d37197f8cfea0 (diff)
downloadcpython-git-740a7cde9c0af5a237a7f6525b38d65a83f4fbf1.tar.gz
bpo-36908: 'This module is always available' isn't helpful. (GH-13297)
Makes the documentation of math and cmath module more helpful for the beginners. (cherry picked from commit 6faad355db6c2bd4a0ade7868f245b42c04f5337) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
-rw-r--r--Doc/library/cmath.rst13
-rw-r--r--Doc/library/math.rst4
-rw-r--r--Modules/cmathmodule.c4
-rw-r--r--Modules/mathmodule.c4
4 files changed, 12 insertions, 13 deletions
diff --git a/Doc/library/cmath.rst b/Doc/library/cmath.rst
index 9d81730f20..28cd96b0e1 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 33aec573a1..b06b054d51 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
diff --git a/Modules/cmathmodule.c b/Modules/cmathmodule.c
index 8319767b8a..b421f04fa6 100644
--- a/Modules/cmathmodule.c
+++ b/Modules/cmathmodule.c
@@ -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
diff --git a/Modules/mathmodule.c b/Modules/mathmodule.c
index 9eaeff1159..8eedca8a30 100644
--- a/Modules/mathmodule.c
+++ b/Modules/mathmodule.c
@@ -2371,8 +2371,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 = {