Skip to content

docs: fix minor typos and improve backtick consistency#853

Open
Vegapunk-debug wants to merge 7 commits intosindresorhus:mainfrom
Vegapunk-debug:main
Open

docs: fix minor typos and improve backtick consistency#853
Vegapunk-debug wants to merge 7 commits intosindresorhus:mainfrom
Vegapunk-debug:main

Conversation

@Vegapunk-debug
Copy link
Copy Markdown
Contributor

Fix minor typos and improve documentation consistency

Description

This PR addresses several minor typos and consistency issues in the ky documentation and source code comments to ensure a high-quality, professional appearance and better readability:

  • Standardized Terminology: Corrected "Ky-instances" to "Ky instances" in the readme.md and type definitions for better style consistency.
  • Improved Syntax Highlighting: Added missing backticks to key code symbols like response and undefined in readme.md code block comments.
  • Professional JSDoc Formatting: Added missing backticks to internal error class names (KyError, HTTPError, NetworkError, TimeoutError, and ForceRetryError) in source/utils/type-guards.ts and source/core/Ky.ts comments.

Type of Change

  • Documentation update (non-breaking change; fixes typos and formatting)

Checklist

  • My changes follow the code style of this project.
  • I have performed a self-review of my own changes.
  • My changes generate no new warnings.

Thank You!

@Vegapunk-debug
Copy link
Copy Markdown
Contributor Author

Vegapunk-debug commented Apr 2, 2026

@sindresorhus @sholladay , could you please review my PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant