From 35fc38e5e82d18ceec95af9af2103319497e2eaf Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Mon, 1 Apr 2019 08:15:10 -0700 Subject: [PATCH] bpo-36157:Document PyInterpreterState_Main() (GH-12238) I have added documentation for `PyInterpreterState_Main()`. I chose to place it under Advanced Debugger Support together with similar functions like `PyInterpreterState_Head()`, `PyInterpreterState_Next(`), and `PyInterpreterState_ThreadHead()` . https://bugs.python.org/issue36157 (cherry picked from commit 8c61739defd88c7f79e86537886c33745843ce01) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> --- Doc/c-api/init.rst | 5 +++++ .../Documentation/2019-03-08-15-39-47.bpo-36157.nF1pP1.rst | 1 + 2 files changed, 6 insertions(+) create mode 100644 Misc/NEWS.d/next/Documentation/2019-03-08-15-39-47.bpo-36157.nF1pP1.rst diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst index 2cdc0527dff9..a88873bd8f23 100644 --- a/Doc/c-api/init.rst +++ b/Doc/c-api/init.rst @@ -1383,6 +1383,11 @@ These functions are only intended to be used by advanced debugging tools. Return the interpreter state object at the head of the list of all such objects. +.. c:function:: PyInterpreterState* PyInterpreterState_Main() + + Return the main interpreter state object. + + .. c:function:: PyInterpreterState* PyInterpreterState_Next(PyInterpreterState *interp) Return the next interpreter state object after *interp* from the list of all diff --git a/Misc/NEWS.d/next/Documentation/2019-03-08-15-39-47.bpo-36157.nF1pP1.rst b/Misc/NEWS.d/next/Documentation/2019-03-08-15-39-47.bpo-36157.nF1pP1.rst new file mode 100644 index 000000000000..ff0293e8407f --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2019-03-08-15-39-47.bpo-36157.nF1pP1.rst @@ -0,0 +1 @@ +Added Documention for PyInterpreterState_Main(). \ No newline at end of file -- 2.47.3