Skip to content

doc: fix grammar and phrasing in typescript.md - #66977

Open
ravi-arnan wants to merge 1 commit into
nodejs:mainfrom
ravi-arnan:doc-fix-typescript-grammar
Open

ravi-arnan wants to merge 1 commit into
nodejs:mainfrom
ravi-arnan:doc-fix-typescript-grammar

Conversation

@ravi-arnan

Copy link
Copy Markdown

Fix small grammar and heading phrasing issues in doc/api/typescript.md:

  • Correct subject-verb agreement in type stripping introduction: "files that contains" -> "files that contain".
  • Add missing indefinite article: "result in [ERR_UNSUPPORTED_TYPESCRIPT_SYNTAX][] error" -> "result in an [ERR_UNSUPPORTED_TYPESCRIPT_SYNTAX][] error".
  • Adjust section heading "Paths aliases" to standard singular form "Path aliases".
  • Clarify verb parallelism: "won't be transformed and will therefore produce an error".

Verification

  • Ran markdown linter: node tools/lint-md/lint-md.mjs doc/api/typescript.md (clean, exit code 0).

Fix grammatical issues and heading phrasing in `doc/api/typescript.md`:
- Correct subject-verb agreement ("files that contains" -> "files that
  contain").
- Add missing indefinite article ("result in an ... error").
- Change heading from "Paths aliases" to "Path aliases" to match
  standard TypeScript terminology.
- Clarify verb parallelism ("won't be transformed and will therefore
  produce an error").

Signed-off-by: Ravi Arnan <raviarnankeren@gmail.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/typescript

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to Node.js documentation. label Oct 24, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Welcome to Node.js, and thank you for your first contribution!

Before review, please take a moment to read:

Please make sure every commit is signed off. For a first pull request, GitHub Actions require collaborator approval and Jenkins CI must be started by a collaborator or triager, so an initial wait is normal.

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

Labels

doc Issues and PRs related to Node.js documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants