docs: clarify baggage current context behavior - #5529
Open
goutamadwant wants to merge 3 commits into
Open
Conversation
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
1 participant
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.
Description
Clarifies that baggage helper functions return updated
Contextvalues and do not mutate or attach the current context automatically.This adds examples showing the difference between reading from the current context, passing an explicit context, and attaching/detaching a returned context. It also keeps the Context API docs focused on Context behavior without describing it in terms of baggage.
Fixes #2432
Type of change
How Has This Been Tested?
uv run tox -e docsDoes This PR Require a Contrib Repo Change?
Checklist: