]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.14] gh-141004: Mark up constants for `PyOS_double_to_string` (GH-143867) (GH-144146)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Thu, 22 Jan 2026 12:30:14 +0000 (13:30 +0100)
committerGitHub <noreply@github.com>
Thu, 22 Jan 2026 12:30:14 +0000 (13:30 +0100)
This ensures they show up as C macros in search and the Sphinx inventory.
(cherry picked from commit fb690c38cafb15e4ccddc52aba37f9470ce201a0)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Doc/c-api/conversion.rst

index 977406eb4d42229ff28517f5756152ab1d3f413c..794e45af66316f7d2f8e753d1a9a5c45487960f8 100644 (file)
@@ -130,6 +130,8 @@ The following functions provide locale-independent string to number conversions.
 
    *flags* can be zero or more of the following values or-ed together:
 
+   .. c:namespace:: NULL
+
    .. c:macro:: Py_DTSF_SIGN
 
       Always precede the returned string with a sign
@@ -151,9 +153,21 @@ The following functions provide locale-independent string to number conversions.
 
       .. versionadded:: 3.11
 
-   If *ptype* is non-``NULL``, then the value it points to will be set to one of
-   ``Py_DTST_FINITE``, ``Py_DTST_INFINITE``, or ``Py_DTST_NAN``, signifying that
-   *val* is a finite number, an infinite number, or not a number, respectively.
+   If *ptype* is non-``NULL``, then the value it points to will be set to one
+   of the following constants depending on the type of *val*:
+
+   .. list-table::
+      :header-rows: 1
+      :align: left
+
+      * - *\*ptype*
+        - type of *val*
+      * - .. c:macro:: Py_DTST_FINITE
+        - finite number
+      * - .. c:macro:: Py_DTST_INFINITE
+        - infinite number
+      * - .. c:macro:: Py_DTST_NAN
+        - not a number
 
    The return value is a pointer to *buffer* with the converted string or
    ``NULL`` if the conversion failed. The caller is responsible for freeing the