Skip to content

[3.13] gh-124872: Refine contextvars documentation (GH-124773) - #125233

Merged
willingc merged 2 commits into
python:3.13from
rhansen:gh-124872-docs
Oct 30, 2024
Merged

[3.13] gh-124872: Refine contextvars documentation (GH-124773)#125233
willingc merged 2 commits into
python:3.13from
rhansen:gh-124872-docs

Conversation

@rhansen

@rhansenrhansen commented Oct 10, 2024

Copy link
Copy Markdown
Contributor
  • Add definitions for "context", "current context", and "context management protocol".
  • Update related definitions to be consistent with the new definitions.
  • Restructure the documentation for the contextvars.Context class to prepare for adding context manager support, and for consistency with the definitions.
  • Use testcode and testoutput to test the Context.run example.

(cherry-picked from commit 9940093)


📚 Documentation preview 📚: https://cpython-previews--125233.org.readthedocs.build/

 * Add definitions for "context", "current context", and "context
management protocol".
* Update related definitions to be consistent with the new
definitions.
* Restructure the documentation for the `contextvars.Context` class
to prepare for adding context manager support, and for consistency
with the definitions.
* Use `testcode` and `testoutput` to test the `Context.run` example.
(cherry-picked from commit 9940093)
@rhansen
rhansen requested a review from 1st1 as a code ownerOctober 10, 2024 07:05
@bedevere-appbedevere-appBot added the docs Documentation in the Doc dir label Oct 10, 2024
rhansen added a commit to rhansen/cpython that referenced this pull request Oct 10, 2024
I opened issue pythongh-124872 after creating PR pythongh-124773 but forgot to
rename the blurb file to match the new issue number. (The cherry-pick
to 3.13 in pythongh-125233 already uses this new filename.)
@willingc
willingc enabled auto-merge (squash) October 30, 2024 20:42
@willingc
willingc merged commit 2db2b5e into python:3.13Oct 30, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dir

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants

@rhansen@willingc