Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

URLSearchParam.append Encoding Behavior #37676

Merged
merged 7 commits into from
Feb 2, 2025
Merged

Conversation

sublimemm
Copy link
Contributor

@sublimemm sublimemm commented Jan 16, 2025

Documenting URLSearchParam.append Encoding Behavior and adding an example.

Description

Motivation

Additional details

Related issues and pull requests

Fix #34896

Documenting URLSearchParam.append Encoding Behavior and adding an example.
@sublimemm sublimemm requested a review from a team as a code owner January 16, 2025 15:06
@sublimemm sublimemm requested review from sideshowbarker and removed request for a team January 16, 2025 15:06
@github-actions github-actions bot added Content:WebAPI Web API docs size/s [PR only] 6-50 LoC changed labels Jan 16, 2025
Copy link
Contributor

github-actions bot commented Jan 16, 2025

Preview URLs (6 pages)
External URLs (2)

URL: /en-US/docs/Web/API/URLSearchParams
Title: URLSearchParams


URL: /en-US/docs/Web/API/URLSearchParams/toString
Title: URLSearchParams: toString() method

(comment last updated: 2025-02-02 20:50:51)

sublimemm and others added 4 commits January 16, 2025 10:10
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@sideshowbarker sideshowbarker removed their request for review January 18, 2025 13:39
@Josh-Cena Josh-Cena self-requested a review January 24, 2025 18:22
@Josh-Cena
Copy link
Member

@sublimemm For interfaces like URLSearchParams, instead of putting behavior documentation under a specific method, we put it under the class's page, because the methods closely interact with each other (there are multiple ways to modify and retrieve data and it's actually abstractly about how the interface transforms external input, not the specific inner workings of append() itself). You will want to add it to https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams instead.

@github-actions github-actions bot added size/m [PR only] 51-500 LoC changed and removed size/s [PR only] 6-50 LoC changed labels Feb 2, 2025
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've moved the explanation to the landing page and added some examples so it also addresses #34896. Thanks for sending it in!

@Josh-Cena Josh-Cena merged commit bfe3107 into mdn:main Feb 2, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Using URLSearchParams.delete method changes the enconding of unrelated search params
2 participants