Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Oct 30, 2024

Conversation

rhansen
Copy link
Contributor

@rhansen rhansen commented Oct 10, 2024

  • 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 owner October 10, 2024 07:05
@bedevere-app bedevere-app bot 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.13 Oct 30, 2024
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants