]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] gh-141004: document Py_INFINITY and Py_NAN macros (GH-141145) (#141400)
authorSergey B Kirpichev <skirpichev@gmail.com>
Tue, 11 Nov 2025 13:52:05 +0000 (16:52 +0300)
committerGitHub <noreply@github.com>
Tue, 11 Nov 2025 13:52:05 +0000 (14:52 +0100)
(cherry picked from commit d69447445cbacf7537bf59c5c683a3b17060312d)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Doc/c-api/float.rst

index dddf126fe084c3fd88ef65adcd03aad9f4444f47..1a3857277b943ac416b24b6769db52ad5f50ffa0 100644 (file)
@@ -78,6 +78,34 @@ Floating-Point Objects
    Return the minimum normalized positive float *DBL_MIN* as C :c:expr:`double`.
 
 
+.. c:macro:: Py_INFINITY
+
+   This macro expands a to constant expression of type :c:expr:`double`, that
+   represents the positive infinity.
+
+   On most platforms, this is equivalent to the :c:macro:`!INFINITY` macro from
+   the C11 standard ``<math.h>`` header.
+
+
+.. c:macro:: Py_NAN
+
+   This macro expands a to constant expression of type :c:expr:`double`, that
+   represents a quiet not-a-number (qNaN) value.
+
+   On most platforms, this is equivalent to the :c:macro:`!NAN` macro from
+   the C11 standard ``<math.h>`` header.
+
+
+.. c:macro:: Py_MATH_El
+
+   High precision (long double) definition of :data:`~math.e` constant.
+
+
+.. c:macro:: Py_MATH_PIl
+
+   High precision (long double) definition of :data:`~math.pi` constant.
+
+
 .. c:macro:: Py_RETURN_NAN
 
    Return :data:`math.nan` from a function.