]> granicus.if.org Git - python/commitdiff
bpo-36157:Document PyInterpreterState_Main() (GH-12238)
authorJoannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>
Mon, 1 Apr 2019 15:08:43 +0000 (18:08 +0300)
committerMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 1 Apr 2019 15:08:43 +0000 (08:08 -0700)
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

Doc/c-api/init.rst
Misc/NEWS.d/next/Documentation/2019-03-08-15-39-47.bpo-36157.nF1pP1.rst [new file with mode: 0644]

index b87e999fe02b43b663630ac2d4a242baaaca4e00..7c1f0ffa44a313897ecadd84ba9fa3fe08c19089 100644 (file)
@@ -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 (file)
index 0000000..ff0293e
--- /dev/null
@@ -0,0 +1 @@
+Added Documention for  PyInterpreterState_Main().
\ No newline at end of file