Skip to content

doc: add comma after "blocks" for clarity in child_process.md #58776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

Conversation

ronijames008
Copy link

doc: add comma after "blocks" for clarity in child_process.md

This PR improves clarity in doc/api/child_process.md by adding a comma after the word "blocks" in the sentence:

... the subprocess blocks, waiting for the pipe buffer to accept more data. ...

The change improves readability and ensures proper grammatical flow. No functional code is affected.

No functional code is affected.

@nodejs-github-bot nodejs-github-bot added child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. labels Jun 21, 2025
Copy link
Member

@edsadr edsadr left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@edsadr edsadr left a comment

Choose a reason for hiding this comment

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

LGTM, but please change the commit message to follow the standard

Adds a comma after "blocks" in a sentence explaining how subprocesses
may pause when the pipe buffer is full. This improves readability and
clarifies the meaning of the sentence, preventing misinterpretation of
"blocks waiting" as a compound phrase.

No functional code is affected.
@ronijames008 ronijames008 force-pushed the docs/fix-grammar-blocks branch from bbf9633 to 65d5a58 Compare June 27, 2025 14:17
@ronijames008 ronijames008 requested a review from a team as a code owner June 27, 2025 14:17
@ronijames008
Copy link
Author

ronijames008 commented Jun 27, 2025

PR closed pre-maturely due to a mistake on my end, new PR created #58862

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants