doc: simplify readline/stdin text #41583
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
Mesteery
approved these changes
Jan 18, 2022
tniessen
reviewed
Jan 18, 2022
| process.stdin.unref(); | ||
| ``` | ||
| will not terminate until it receives an [EOF character][]. To exit without | ||
| waiting for user input, call `process.stdin.unref()`. |
There was a problem hiding this comment.
Is removing the reference to the unref() documentation intentional?
There was a problem hiding this comment.
Yes although it wasn't an easy decision. The choices were:
- Use wording that isn't straightforward simply so we can include
unref()by itself and link that to thenetdocs. (This is what the existing text does.) - Use the simple/straightforward wording here but add a possibly-confusing link for
process.stdin.unref()to thenetdoc description ofunref(). - Use the simple/straightforward wording here that tells the user what they need to know, and don't bother with a link to
unref(). At a later date, address the fact that our docs can be non-intuitive. If I findprocess.stdin.unref()mentioned in code or a tutorial, good luck finding it in the docs. I'm not sure what the solution is, but I think we should solve it. We should not be relying on linking every mention to a surprising place.
|
@nodejs/documentation |
addaleax
approved these changes
Jan 22, 2022
Trott
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in fbfb61a |
BethGriggs
pushed a commit
that referenced
this pull request
Jan 25, 2022
PR-URL: #41583 Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Linkgoron
pushed a commit
to Linkgoron/node
that referenced
this pull request
Jan 31, 2022
PR-URL: nodejs#41583 Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
danielleadams
pushed a commit
that referenced
this pull request
Feb 28, 2022
PR-URL: #41583 Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
danielleadams
pushed a commit
that referenced
this pull request
Mar 2, 2022
PR-URL: #41583 Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
danielleadams
pushed a commit
that referenced
this pull request
Mar 3, 2022
PR-URL: #41583 Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
danielleadams
pushed a commit
that referenced
this pull request
Mar 14, 2022
PR-URL: #41583 Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.