docs: clarify params query canonicalization behavior#12202
docs: clarify params query canonicalization behavior#12202Dreamsorcerer merged 1 commit intoaio-libs:masterfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #12202 +/- ##
=======================================
Coverage 98.88% 98.88%
=======================================
Files 130 130
Lines 45388 45388
Branches 2417 2417
=======================================
+ Hits 44880 44882 +2
+ Misses 350 347 -3
- Partials 158 159 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Gentle ping — all CI checks pass (tests, linters, benchmarks across all platforms and Python versions). The only failing check is |
Backport to 3.14: 💚 backport PR created✅ Backport PR branch: Backported as #12369 🤖 @patchback |
(cherry picked from commit 07bd8c1)
What do these changes do?
This updates the client quickstart docs around
paramswith string values.The previous wording suggested that string params are "not encoded by library". The updated text clarifies that using
paramsdoes not disable URL canonicalization/requoting, and keeps the existing+example.I also expanded the warning for
encoded=Trueto make it explicit thatparamsoverrides it, and that preserving exact query-string bytes requires building the full URL (including query) withoutparams.Are there changes in behavior for the user?
No runtime behavior changes. This is a documentation-only clarification.
Is it a substantial burden for the maintainers to support this?
No. This is a small wording change in one doc section.
Related issue number
Fixes #3689
Checklist
CONTRIBUTORS.txtCHANGES/folder