From: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
Date: Mon, 1 Apr 2019 15:08:43 +0000 (+0300)
Subject: bpo-36157:Document PyInterpreterState_Main() (GH-12238)
X-Git-Tag: v3.8.0a4~278
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8c61739defd88c7f79e86537886c33745843ce01;p=thirdparty%2FPython%2Fcpython.git

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
---

diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index b87e999fe02b..7c1f0ffa44a3 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -1395,6 +1395,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