[3.13] Docs: C API: Fix the incorrect PyThreadState_Swap documentation
#133900
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kumaraditya303
approved these changes
May 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've already fixed this for main and 3.14 in gh-127990, but that wasn't backported to 3.13. I'm not planning on fixing any other 3.13 docs, but
PyThreadState_Swapis especially bad, because the documentation says you need to hold the GIL to call it, which is wrong and would defeat the whole point of the function if it were true. I've seen people get confused by that on several different occasions.📚 Documentation preview 📚: https://cpython-previews--133900.org.readthedocs.build/en/133900/c-api/init.html#c.PyThreadState_Swap