From: Sergey B Kirpichev Date: Tue, 11 Nov 2025 13:52:05 +0000 (+0300) Subject: [3.13] gh-141004: document Py_INFINITY and Py_NAN macros (GH-141145) (#141400) X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=05e7b0dadf0c3c1f3c03573beabf7c88a46a1bcf;p=thirdparty%2FPython%2Fcpython.git [3.13] gh-141004: document Py_INFINITY and Py_NAN macros (GH-141145) (#141400) (cherry picked from commit d69447445cbacf7537bf59c5c683a3b17060312d) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> --- diff --git a/Doc/c-api/float.rst b/Doc/c-api/float.rst index dddf126fe084..1a3857277b94 100644 --- a/Doc/c-api/float.rst +++ b/Doc/c-api/float.rst @@ -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 ```` 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 ```` 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.