Repository navigation
gh-124872: Refine contextvars documentation - #124773
Merged
1st1 merged 1 commit intoOct 9, 2024
Merged
1st1 merged 1 commit into
1st1 merged 1 commit into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
rhansen
force-pushed
the
gh-119333-99633-docs
branch
from
c99ca89 to
b16f493
Compare
September 29, 2024 23:31
* 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.
* Expand the documentation for the `Py_CONTEXT_EVENT_ENTER` and
`Py_CONTEXT_EVENT_EXIT` events to clarify and to prepare for
planned changes.
rhansen
force-pushed
the
gh-119333-99633-docs
branch
from
b16f493 to
c38c1c6
Compare
October 1, 2024 23:23
1st1
approved these changes
Oct 9, 2024
1st1
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Excellent stuff. Thank you.
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
Huge +1. |
Sorry, something went wrong.
Copy link
Copy Markdown
|
Sorry, @rhansen and @1st1, I could not cleanly backport this to 3.13 due to a conflict. cherry_picker 99400930ac1d4e5e10a5ae30f8202d8bc2661e39 3.13 |
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
@rhansen can you submit a PR against 3.13 please? |
Sorry, something went wrong.
Copy link
Copy Markdown
|
GH-125233 is a backport of this pull request to the 3.13 branch. |
Sorry, something went wrong.
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
added a commit
that referenced
this pull request
Oct 30, 2024
[3.13] gh-124872: Refine contextvars documentation * 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) Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
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
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.
cc @fried
📚 Documentation preview 📚: https://cpython-previews--124773.org.readthedocs.build/