summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2022-04-02 13:19:20 -0700
committerGitHub <noreply@github.com>2022-04-02 13:19:20 -0700
commit319a70cf99c9866c7fa47deecf04f6ebcfe35a54 (patch)
treea57d4f9002bf5dc68fe5d975ad262c392e72d57a
parent5830a288abc00fc4fca57ebe18e42dc78334a279 (diff)
downloadcpython-git-319a70cf99c9866c7fa47deecf04f6ebcfe35a54.tar.gz
bpo-47031: Improve documentation for `math.nan` (GH-32170)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 182e93c3f57b0c72e765c9896066d32e461c0865) Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
-rw-r--r--Doc/library/math.rst19
1 files changed, 17 insertions, 2 deletions
diff --git a/Doc/library/math.rst b/Doc/library/math.rst
index 145bac4966..d485ae5c27 100644
--- a/Doc/library/math.rst
+++ b/Doc/library/math.rst
@@ -627,8 +627,23 @@ Constants
.. data:: nan
- A floating-point "not a number" (NaN) value. Equivalent to the output of
- ``float('nan')``.
+ A floating-point "not a number" (NaN) value. Equivalent to the output of
+ ``float('nan')``. Due to the requirements of the `IEEE-754 standard
+ <https://en.wikipedia.org/wiki/IEEE_754>`_, ``math.nan`` and ``float('nan')`` are
+ not considered to equal to any other numeric value, including themselves. To check
+ whether a number is a NaN, use the :func:`isnan` function to test
+ for NaNs instead of ``is`` or ``==``.
+ Example::
+
+ >>> import math
+ >>> math.nan == math.nan
+ False
+ >>> float('nan') == float('nan')
+ False
+ >>> math.isnan(math.nan)
+ True
+ >>> math.isnan(float('nan'))
+ True
.. versionadded:: 3.5