Skip to content

docs: clarify params query canonicalization behavior#12202

Merged
Dreamsorcerer merged 1 commit intoaio-libs:masterfrom
mitre88:codex/issue-3689-query-params-doc
Apr 13, 2026
Merged

docs: clarify params query canonicalization behavior#12202
Dreamsorcerer merged 1 commit intoaio-libs:masterfrom
mitre88:codex/issue-3689-query-params-doc

Conversation

@mitre88
Copy link
Copy Markdown
Contributor

@mitre88 mitre88 commented Mar 5, 2026

What do these changes do?

This updates the client quickstart docs around params with string values.

The previous wording suggested that string params are "not encoded by library". The updated text clarifies that using params does not disable URL canonicalization/requoting, and keeps the existing + example.

I also expanded the warning for encoded=True to make it explicit that params overrides it, and that preserving exact query-string bytes requires building the full URL (including query) without params.

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

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
  • Add a new news fragment into the CHANGES/ folder

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.88%. Comparing base (8874959) to head (5a9d104).
⚠️ Report is 215 commits behind head on master.
✅ All tests successful. No failed tests found.

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     
Flag Coverage Δ
CI-GHA 98.74% <ø> (+<0.01%) ⬆️
OS-Linux 98.49% <ø> (+0.01%) ⬆️
OS-Windows 96.75% <ø> (ø)
OS-macOS 97.64% <ø> (+<0.01%) ⬆️
Py-3.10.11 97.19% <ø> (-0.01%) ⬇️
Py-3.10.19 97.66% <ø> (+<0.01%) ⬆️
Py-3.11.14 97.86% <ø> (ø)
Py-3.11.9 97.40% <ø> (+<0.01%) ⬆️
Py-3.12.10 97.49% <ø> (+<0.01%) ⬆️
Py-3.12.12 97.96% <ø> (ø)
Py-3.13.12 98.21% <ø> (+<0.01%) ⬆️
Py-3.14.3 98.26% <ø> (ø)
Py-3.14.3t 97.27% <ø> (+<0.01%) ⬆️
Py-pypy3.11.13-7.3.20 97.30% <ø> (+<0.01%) ⬆️
VM-macos 97.64% <ø> (+<0.01%) ⬆️
VM-ubuntu 98.49% <ø> (+0.01%) ⬆️
VM-windows 96.75% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Mar 5, 2026

Merging this PR will not alter performance

✅ 59 untouched benchmarks


Comparing mitre88:codex/issue-3689-query-params-doc (5a9d104) with master (16ffed7)1

Open in CodSpeed

Footnotes

  1. No successful run was found on master (8874959) during the generation of this report, so 16ffed7 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@mitre88
Copy link
Copy Markdown
Contributor Author

mitre88 commented Apr 13, 2026

Gentle ping — all CI checks pass (tests, linters, benchmarks across all platforms and Python versions). The only failing check is Backport label added which is a repo automation issue, not a code problem. This docs PR is ready for review. Thanks!

@Dreamsorcerer Dreamsorcerer added bot:chronographer:skip This PR does not need to include a change note backport-3.14 Trigger automatic backporting to the 3.14 release branch by Patchback robot labels Apr 13, 2026
@Dreamsorcerer Dreamsorcerer merged commit 07bd8c1 into aio-libs:master Apr 13, 2026
46 of 47 checks passed
@patchback
Copy link
Copy Markdown
Contributor

patchback Bot commented Apr 13, 2026

Backport to 3.14: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.14/07bd8c1d36d19e5ee38146d44607d758a81893b3/pr-12202

Backported as #12369

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback Bot pushed a commit that referenced this pull request Apr 13, 2026
Dreamsorcerer pushed a commit that referenced this pull request Apr 13, 2026
…calization behavior (#12369)

**This is a backport of PR #12202 as merged into master
(07bd8c1).**

Co-authored-by: Dr Alex Mitre <bedr10_capacitacion@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-3.14 Trigger automatic backporting to the 3.14 release branch by Patchback robot bot:chronographer:skip This PR does not need to include a change note

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation misleading on query string encoding

2 participants