[3.13] gh-141004: Document `Py_MakePendingCalls` (GH-141137) (GH-141788)

gh-141004: Document `Py_MakePendingCalls` (GH-141137)
(cherry picked from commit ce701032a3d5d3597466d5836ebe989db6eda2aa)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>

diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index c2026922c70368b5e3ed777de3136afb18a81d7b..a285c2467ae3742b5ffc7e04faec6fce8b0b9478 100644 (file)
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -1964,6 +1964,25 @@ pointer and a void pointer argument.
       This function now always schedules *func* to be run in the main
       interpreter.
 
+
+.. c:function:: int Py_MakePendingCalls(void)
+
+   Execute all pending calls. This is usually executed automatically by the
+   interpreter.
+
+   This function returns ``0`` on success, and returns ``-1`` with an exception
+   set on failure.
+
+   If this is not called in the main thread of the main
+   interpreter, this function does nothing and returns ``0``.
+   The caller must hold the :term:`GIL`.
+
+   .. versionadded:: 3.1
+
+   .. versionchanged:: 3.12
+      This function only runs pending calls in the main interpreter.
+
+
 .. _profiling:
 
 Profiling and Tracing