bpo-36157:Document PyInterpreterState_Main() (GH-12238)

miss-islington · nanjekyejoannah · web-flow · commit 35fc38e5e82d · 2019-04-01T08:15:10.000-07:00
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 8c61739) Co-authored-by: Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
diff --git 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
@@ -0,0 +1 @@
+Added Documention for  PyInterpreterState_Main().

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Added Documention for PyInterpreterState_Main().`