docs: clarify mutable and immutable URI query methods#10348
Merged
paulbalandan merged 1 commit intoJun 30, 2026
Conversation
- add a user guide table mapping mutable query methods to immutable helpers - note that immutable query helpers clone the URI instead of mutating it - add TODO notes for future mutable query method deprecations Signed-off-by: memleakd <121398829+memleakd@users.noreply.github.com>
michalsn
approved these changes
Jun 29, 2026
michalsn
left a comment
michalsn
left a comment
Member
There was a problem hiding this comment.
Thank you for the follow-up!
paulbalandan
approved these changes
Jun 30, 2026
Member
|
Thank you, @memleakd |
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
3 participants
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
This follows up on #10268 and @michalsn’s suggestion to make the URI query docs clearer.
The URI user guide now lists the mutable query methods next to their immutable alternatives, and explicitly notes that the
with*()helpers return cloned URI instances while the older methods mutate the current instance.I also added non-runtime TODO notes to the mutable query method docblocks for the future major-version deprecation direction. These are not runtime deprecations and do not add
@deprecatedtags.Checklist: