Skip to content

Improve GET request example clarity in documentation.#10836

Merged
jasonsaayman merged 3 commits into
axios:v1.xfrom
hpinmetaverse:hpinmetaverse-improve_get_exampleDoc-1
May 2, 2026
Merged

Improve GET request example clarity in documentation.#10836
jasonsaayman merged 3 commits into
axios:v1.xfrom
hpinmetaverse:hpinmetaverse-improve_get_exampleDoc-1

Conversation

@hpinmetaverse

@hpinmetaverse hpinmetaverse commented May 2, 2026

Copy link
Copy Markdown
Contributor
  • Improved GET request example using 'params' for better readability.
  • Added explanation for query parameter handling.

This enhances clarity for developers working with API requests.


Summary by cubic

Clarifies the README GET request example by using axios params, adds inline comments, and fixes indentation for readability. Docs-only; no behavior changes.

Description

  • Replace axios.get('/user?ID=12345') with axios.get('/user', { params: { ID: 12345 } }).
  • Add inline comments noting params improves readability and auto-formats query strings.
  • Fix indentation for consistent style.

Docs & Impact

  • Mirror this example in the /docs/ site to keep examples consistent.
  • Testing: not needed (docs-only).
  • Semantic version impact: none.

Written for commit 9cd706c. Summary will update on new commits.

Updated example GET request to use params for clarity.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 1 file

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

@jasonsaayman jasonsaayman added priority::medium A medium priority commit::docs The PR is related to docs labels May 2, 2026
Comment thread README.md
@jasonsaayman jasonsaayman added the status::changes-requested A reviewer requested changes to the PR label May 2, 2026
@hpinmetaverse hpinmetaverse requested a review from jasonsaayman May 2, 2026 16:26
@jasonsaayman jasonsaayman merged commit 0506080 into axios:v1.x May 2, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

commit::docs The PR is related to docs priority::medium A medium priority status::changes-requested A reviewer requested changes to the PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants