python / python/cpython

Free threading glossary of building blocks

Open
#128,642 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs topic-free-threading
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

As suggested by @markshannon and @Yhg1s:

  • What are the building blocks? Things like _Py_TryXGetRef and _Py_TryIncrefCompare.
  • What are the thread safety guarantees that we are aiming for?

InternalDocs might be a good place.

Linked PRs
  • gh-144644

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the InternalDocs area and the linked PR gh-144644 first. The issue identifies _Py_TryXGetRef and _Py_TryIncrefCompare as examples and asks for the building blocks and target thread-safety guarantees. Done means those concepts and guarantees are documented in a glossary.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.