Skip to content

gh-145912: Fix stale and incorrect free-threading statements in the docs - #161162

Open
johng wants to merge 2 commits into
python:mainfrom
johng:docs-free-threading-fixes
Open

johng wants to merge 2 commits into
python:mainfrom
johng:docs-free-threading-fixes

Conversation

@johng

@johng johng commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Part of the free-threading docs tracking issue (gh-145912).

Fixes statements that are out of date or wrong for the free-threaded build:

  • howto/free-threading-extensions.rst: said the free-threaded build does not support the stable ABI; 3.15 added abi3t. Now points to it and keeps the advice for 3.14 and older.
  • faq/library.rst: the atomic-operations answer explained atomicity only through the GIL; added a free-threaded note linking to the thread-safety page. The "get rid of the GIL" answer described the work as future.
  • library/threading.rst: no longer says free threading is unavailable; removed the stale TODO.
  • howto/free-threading-python.rst: the immortalization list now says all interned strings are immortal (as the memory section already did) and notes the objects immortal in both builds. The deferred reference counting list now includes classmethod and staticmethod objects.

johng added 2 commits November 1, 2026 19:34
* The extensions HOWTO claimed the free-threaded build does not support the
  stable ABI; 3.15 added abi3t.
* The library FAQ described GIL-based atomicity and the GIL removal as
  future work without mentioning the free-threaded build.
* threading no longer describes free threading as unavailable.
* The free-threading HOWTO's immortalization and deferred reference counting
  lists were incomplete.
@bedevere-app bedevere-app Bot mentioned this pull request Nov 2, 2026
18 of 49 tasks
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Nov 2, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Nov 2, 2026
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35574983 | 📁 Comparing 494a2ea against main (67683da)

  🔍 Preview build  

4 files changed
± faq/library.html
± howto/free-threading-extensions.html
± howto/free-threading-python.html
± library/threading.html

@johng

johng commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor Author

Reviewed this myself, looks fine, small changes to bring above issues up to speed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant