Skip to content

gh-141004: document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN #141544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+35 −1
Open

gh-141004: document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN #141544

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d2a1cbe
gh-141004: document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN
skirpichev Nov 14, 2025
202c27f
+1
skirpichev Nov 14, 2025
54741ca
Merge branch 'master' into docs-for-math-macros/141004
skirpichev Nov 14, 2025
b1d30c3
address review: Py_HUGE_VAL & :term:`soft deprecated`
skirpichev Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion Doc/c-api/float.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Floating-Point Objects
``<math.h>`` header.

.. deprecated:: 3.15
The macro is soft deprecated.
The macro is :term:`soft deprecated`.


.. c:macro:: Py_NAN
Expand All @@ -99,6 +99,14 @@ Floating-Point Objects
the C11 standard ``<math.h>`` header.


.. c:macro:: Py_HUGE_VAL

Equivalent to :c:macro:`Py_INFINITY`.

.. deprecated:: 3.14
The macro is :term:`soft deprecated`.


.. c:macro:: Py_MATH_E

The definition (accurate for a :c:expr:`double` type) of the :data:`math.e` constant.
Expand Down Expand Up @@ -147,6 +155,32 @@ Floating-Point Objects
return PyFloat_FromDouble(copysign(INFINITY, sign));


.. c:macro:: Py_IS_FINITE

Determines if the given floating-point number has finite value i.e. it is
normal, subnormal or zero, but not infinite or NaN.
Comment on lines +160 to +161
Copy link
Member

@StanFromIreland StanFromIreland Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Determines if the given floating-point number has finite value i.e. it is
normal, subnormal or zero, but not infinite or NaN.
Determines if the given floating-point number has finite value,
that is, it is normal, subnormal or zero, but not infinite or NaN.

Per the Docs Style guide.

- i.e.
+ , that is,


.. deprecated:: 3.14
The macro is :term:`soft deprecated`. Use :c:macro:`!isfinite` instead.


.. c:macro:: Py_IS_INFINITE
Copy link
Member

@StanFromIreland StanFromIreland Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This macro does not exist? I presume you meant:

Suggested change
.. c:macro:: Py_IS_INFINITE
.. c:macro:: Py_IS_INFINITY


Determines if the given floating-point number is positive or negative
infinity.

.. deprecated:: 3.14
The macro is :term:`soft deprecated`. Use :c:macro:`!isinf` instead.


.. c:macro:: Py_IS_NAN

Determines if the given floating-point number is a not-a-number (NaN) value.

.. deprecated:: 3.14
The macro is :term:`soft deprecated`. Use :c:macro:`!isnan` instead.


Pack and Unpack functions
-------------------------

Expand Down
Loading