[3.13] gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-122280) (#122645)

skirpichev · web-flow · commit fe65a8b0d7a8 · 2024-08-05T20:11:34.000+02:00
[3.13] gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-GH-122280) (cherry picked from commit d91ac52)
diff --git a/Doc/c-api/long.rst b/Doc/c-api/long.rst
@@ -501,6 +501,17 @@ distinguished from a number.  Use :c:func:`PyErr_Occurred` to disambiguate.
    .. versionadded:: 3.13
 
 
+.. c:function:: PyObject* PyLong_GetInfo(void)
+
+   On success, return a read only :term:`named tuple`, that holds
+   information about Python's internal representation of integers.
+   See :data:`sys.int_info` for description of individual fields.
+
+   On failure, return ``NULL`` with an exception set.
+
+   .. versionadded:: 3.1
+
+
 .. c:function:: int PyUnstable_Long_IsCompact(const PyLongObject* op)
 
    Return 1 if *op* is compact, 0 otherwise.
