https://github.com/python/cpython/commit/8d92823ecade2543a8c1f47c0557e204d665074c
commit: 8d92823ecade2543a8c1f47c0557e204d665074c
branch: 3.13
author: Peter Bierma <[email protected]>
committer: kumaraditya303 <[email protected]>
date: 2025-05-19T18:24:00+05:30
summary:
[3.13] Docs: C API: Fix the incorrect `PyThreadState_Swap` documentation
(#133900)
files:
M Doc/c-api/init.rst
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index 36a4976010bde6..323dc9968281e6 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -1190,9 +1190,10 @@ code, or when embedding the Python interpreter:
.. c:function:: PyThreadState* PyThreadState_Swap(PyThreadState *tstate)
Swap the current thread state with the thread state given by the argument
- *tstate*, which may be ``NULL``. The global interpreter lock must be held
- and is not released.
+ *tstate*, which may be ``NULL``.
+ The :term:`GIL` does not need to be held, but will be held upon returning
+ if *tstate* is non-``NULL``.
The following functions use thread-local storage, and are not compatible
with sub-interpreters:
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
