Improve GET request example clarity in documentation.#10836
Merged
jasonsaayman merged 3 commits intoMay 2, 2026
Merged
Conversation
Updated example GET request to use params for clarity.
jasonsaayman
requested changes
May 2, 2026
jasonsaayman
approved these changes
May 2, 2026
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
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.
This enhances clarity for developers working with API requests.
Summary by cubic
Clarifies the README GET request example by using
axiosparams, adds inline comments, and fixes indentation for readability. Docs-only; no behavior changes.Description
axios.get('/user?ID=12345')withaxios.get('/user', { params: { ID: 12345 } }).paramsimproves readability and auto-formats query strings.Docs & Impact
/docs/site to keep examples consistent.Written for commit 9cd706c. Summary will update on new commits.