Skip to content

Commit d91ac52

Browse files
authored
gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-#122280)
1 parent 7a5c410 commit d91ac52

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Doc/c-api/long.rst

+11
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,17 @@ distinguished from a number. Use :c:func:`PyErr_Occurred` to disambiguate.
514514
.. versionadded:: 3.14
515515
516516
517+
.. c:function:: PyObject* PyLong_GetInfo(void)
518+
519+
On success, return a read only :term:`named tuple`, that holds
520+
information about Python's internal representation of integers.
521+
See :data:`sys.int_info` for description of individual fields.
522+
523+
On failure, return ``NULL`` with an exception set.
524+
525+
.. versionadded:: 3.1
526+
527+
517528
.. c:function:: int PyUnstable_Long_IsCompact(const PyLongObject* op)
518529
519530
Return 1 if *op* is compact, 0 otherwise.

0 commit comments

Comments
 (0)