Skip to content

gh-141004: document Py_INFINITY macro #141145

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 2 commits into
base: main
Choose a base branch
from
Open

gh-141004: document Py_INFINITY macro #141145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56740f1
gh-141004: document Py_INFINITY macro
skirpichev Nov 6, 2025
33bbedc
Update Doc/c-api/float.rst
skirpichev Nov 6, 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
9 changes: 9 additions & 0 deletions Doc/c-api/float.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,15 @@ Floating-Point Objects
Return the minimum normalized positive float *DBL_MIN* as C :c:expr:`double`.


.. c:macro:: Py_INFINITY

This is equivalent to the :c:macro:`!INFINITY` macro from the C11 standard
``<math.h>`` header.

.. deprecated:: 3.15
The macro is soft deprecated.
Comment on lines +86 to +87
Copy link
Member

@ZeroIntensity ZeroIntensity Nov 6, 2025

Choose a reason for hiding this comment

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

Let's remove this note so we can backport this, and then #141033 will add it back (for 3.15 only) once the C API WG approves the deprecation.

Copy link
Contributor Author

@skirpichev skirpichev Nov 6, 2025

Choose a reason for hiding this comment

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

I think it's fine to backport depreciation, if it will be approved.

Copy link
Member

@vstinner vstinner Nov 6, 2025

Choose a reason for hiding this comment

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

Usually, deprecations are not backported.

Copy link
Member

@ZeroIntensity ZeroIntensity Nov 6, 2025

Choose a reason for hiding this comment

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

I'm not aware of anyone else doing that. Do you know of a deprecation being backported to older versions?

Copy link
Contributor Author

@skirpichev skirpichev Nov 6, 2025

Choose a reason for hiding this comment

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

Do you know of a deprecation being backported to older versions?

E.g.: #124386.

Copy link
Member

@ZeroIntensity ZeroIntensity Nov 7, 2025

Choose a reason for hiding this comment

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

Ok, in that case, I'm fine with backporting #141033, but we should still remove the note from this PR if we want to land it soon, since the C API WG hasn't approved deprecating anything yet.

Copy link
Contributor Author

@skirpichev skirpichev Nov 7, 2025

Choose a reason for hiding this comment

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

I'm fine with backporting #141033

No, that pr is not going to be backported, only docs here.

we should still remove the note from this PR if we want to land it soon

No need to rush. Lets wait decision. Then we could merge this pr (with or without the deprecation and then, maybe, the #141033 - which might be rejected)

Comment on lines +85 to +87
Copy link
Contributor Author

@skirpichev skirpichev Nov 7, 2025

Choose a reason for hiding this comment

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

Suggested change
.. deprecated:: 3.15
The macro is soft deprecated.



.. c:macro:: Py_RETURN_NAN

Return :data:`math.nan` from a function.
Expand Down
Loading