Skip to content

doc: fix grammar and punctuation in cli.md - #65237

Open
Rawal27 wants to merge 4 commits into
nodejs:mainfrom
Rawal27:doc-fix-cli-documentation
Open

doc: fix grammar and punctuation in cli.md#65237
Rawal27 wants to merge 4 commits into
nodejs:mainfrom
Rawal27:doc-fix-cli-documentation

Conversation

@Rawal27

@Rawal27 Rawal27 commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Description

Improve the grammar, spelling, and punctuation in the command-line API documentation.

Changes

  • Correct grammatical issues in descriptions of command-line options.
  • Fix incorrect articles, such as an native to a native and a implicit to an implicit.
  • Correct subject–verb agreement issues.
  • Correct spelling errors such as serializablility to serializability.
  • Fix punctuation and hyphenation issues.
  • Correct terminology such as out-of-bound to out-of-bounds.
  • Improve the clarity of a few grammatically unclear sentences.

Changes are documentation-only. No functional changes.

Signed-off-by: Rawal27 <obviouslykamal@gmail.com>
@nodejs-github-bot nodejs-github-bot added cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations. labels Aug 12, 2026
Signed-off-by: Rawal27 <obviouslykamal@gmail.com>
Comment thread doc/api/cli.md Outdated

@MikeMcC399 MikeMcC399 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.

Good catches on grammar!

There is however a linting error that needs to be addressed:

doc/node.1 is out of date; run make node.1 to regenerate it.

Rawal27 and others added 2 commits August 12, 2026 14:16
Signed-off-by: Rawal27 <obviouslykamal@gmail.com>
Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants