diff options
| author | Joannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com> | 2019-04-01 15:08:43 (GMT) |
|---|---|---|
| committer | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-04-01 15:08:43 (GMT) |
| commit | 8c61739defd88c7f79e86537886c33745843ce01 (patch) | |
| tree | 03dba2ea57e7e5527283390e997fce92aaf178af | |
| parent | a4d78362397fc3bced6ea80fbc7b5f4827aec55e (diff) | |
| download | cpython-8c61739defd88c7f79e86537886c33745843ce01.zip cpython-8c61739defd88c7f79e86537886c33745843ce01.tar.gz cpython-8c61739defd88c7f79e86537886c33745843ce01.tar.bz2 | |
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
| -rw-r--r-- | Doc/c-api/init.rst | 5 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2019-03-08-15-39-47.bpo-36157.nF1pP1.rst | 1 |
2 files changed, 6 insertions, 0 deletions
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst index b87e999..7c1f0ff 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 0000000..ff0293e --- /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 |