bpo-47031: Improve documentation for math.nan (GH-32170)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 182e93c3f5)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
This commit is contained in:
Miss Islington (bot) 2022-04-02 13:19:20 -07:00 committed by GitHub
parent 5830a288ab
commit 319a70cf99
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

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