doc: general improvements to readline.md copy #7022
Closed
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
jasnell
added
doc
| If `output` is set to `null` or `undefined` when calling `createInterface`, | ||
| nothing is displayed. | ||
| *Note* Once this code is invoked, the Node.js application will not | ||
| terminate until the `readline` interface is closed. |
There was a problem hiding this comment.
Might want to explain here that this is because the interface waits for data from the input stream? Feel free to omit if you think that would go too much into detail.
|
See also: #6996 … Maybe cherry-pick that into this PR as a second commit? |
|
If #6996 lands first I'll rebase this on it. If this lands first, I'll cherry pick it in |
|
Nits fixed! |
| const readline = require('readline'); | ||
| const rl = readline.createInterface(process.stdin, process.stdout); | ||
|
|
||
| rl.setPrompt('OHAI> '); |
There was a problem hiding this comment.
Maybe 'Tiny> '? (No need to change if you'd like to keep the ohai though imo)
There was a problem hiding this comment.
meh, I'm good with ohai for the example
jasnell
force-pushed
the
doc-readline-copy
branch
from
80f7270
to
95383e0
Compare
|
Nits addressed. @nodejs/documentation ... one final look please :-) |
|
ping @nodejs/documentation |
|
LGTM |
jasnell
force-pushed
the
doc-readline-copy
branch
from
95383e0
to
da86df3
Compare
jasnell
force-pushed
the
doc-readline-copy
branch
from
da86df3
to
1d7e233
Compare
|
Rebased to resolve conflicts after the added details were added |
Clarify that readline's rl.question() callback does not use the err back pattern. Fixes: nodejs#4833
jasnell
added a commit
that referenced
this pull request
Jun 7, 2016
PR-URL: #7022 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
evanlucas
pushed a commit
that referenced
this pull request
Jun 15, 2016
PR-URL: #7022 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Merged
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.
Checklist
Affected core subsystem(s)
doc (readline)
Description of change
General improvements to readline.md copy
@nodejs/documentation