Skip to content

docs: fix typos and grammar in advanced docs#10905

Merged
jasonsaayman merged 2 commits into
axios:v1.xfrom
RonGamzu:fix/docs-typos-advanced
May 24, 2026
Merged

docs: fix typos and grammar in advanced docs#10905
jasonsaayman merged 2 commits into
axios:v1.xfrom
RonGamzu:fix/docs-typos-advanced

Conversation

@RonGamzu
Copy link
Copy Markdown
Contributor

@RonGamzu RonGamzu commented May 18, 2026

Summary

Fixes three small typos / grammar issues in the English docs/pages/advanced/ pages. Pure copy edits — no code or behavior changes.

Changes

  • docs/pages/advanced/error-handling.md: "get a object" → "get an object" (article agreement before vowel sound).
  • docs/pages/advanced/request-config.md: add the missing comma in the transformRequest return type list — "Buffer, ArrayBuffer FormData or Stream" → "Buffer, ArrayBuffer, FormData or Stream". The README and the es / zh / fr translations of the same sentence already have the comma, so this aligns the English page with them.
  • docs/pages/advanced/x-www-form-urlencoded-format.md: add a missing space after a comma — "browsers,and [Node]" → "browsers, and [Node]".

Checklist

  • Tests added or updated (or N/A with reason) — N/A, docs-only.
  • Docs / types updated if public API changed — N/A, no API change.
  • No breaking changes.

Summary by cubic

Fixes three small typos in the advanced docs for clarity and consistency. Docs-only; no code or behavior changes.

  • Docs

    • error-handling.md: "get a object" → "get an object".
    • request-config.md: add missing comma in transformRequest return types ("Buffer, ArrayBuffer, FormData or Stream").
    • x-www-form-urlencoded-format.md: add missing space after a comma ("browsers, and [Node]").
    • Suggest updating the published docs site after merge; pages in /docs/pages/advanced/ are updated here.
  • Testing and Versioning

    • Testing: N/A (docs-only).
    • Semantic version impact: Patch (docs-only; no API changes).

Written for commit 5c3e788. Summary will update on new commits. Review in cubic

- error-handling: "get a object" -> "get an object"
- request-config: add missing comma in transformRequest return type list
  (Buffer, ArrayBuffer, FormData or Stream) to match README.md and the
  es/zh/fr translations
- x-www-form-urlencoded-format: add missing space after comma in
  "browsers,and [Node]"
@RonGamzu RonGamzu requested a review from jasonsaayman as a code owner May 18, 2026 18:02
Copy link
Copy Markdown
Contributor

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

Choose a reason for hiding this comment

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

No issues found across 3 files

Confidence score: 5/5

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

Re-trigger cubic

@jasonsaayman jasonsaayman added priority::low A low priority issue commit::docs The PR is related to docs labels May 18, 2026
@RonGamzu
Copy link
Copy Markdown
Contributor Author

@jasonsaayman Please update me if I need to make any additional changes in order for you to approve the merge request.

Copy link
Copy Markdown
Member

@jasonsaayman jasonsaayman left a comment

Choose a reason for hiding this comment

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

LGTM 🔥

@jasonsaayman jasonsaayman merged commit 67e10e7 into axios:v1.x May 24, 2026
23 checks passed
jasonsaayman added a commit that referenced this pull request May 28, 2026
- error-handling: "get a object" -> "get an object"
- request-config: add missing comma in transformRequest return type list
  (Buffer, ArrayBuffer, FormData or Stream) to match README.md and the
  es/zh/fr translations
- x-www-form-urlencoded-format: add missing space after comma in
  "browsers,and [Node]"

Co-authored-by: Jay <[email protected]>
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::low A low priority issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants