doc: general improvements to repl.md copy #7002
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
36 tasks
| * `.exit` - Close the I/O stream, causing the REPL to exit. | ||
| * `.help` - Show this list of special commands. | ||
| * `.save` - Save the current REPL session to a file: | ||
| `>.save ./file/to/save.js` |
There was a problem hiding this comment.
I know it’s only copied, but there should be a space between > and .save, right?
|
LGTM with a couple of comments |
| and output may be from `stdin` and `stdout`, respectively, or may be connected | ||
| to any Node.js [stream][]. | ||
|
|
||
| Instances of `repl.REPLServer` support persistent history of prior inputs, |
There was a problem hiding this comment.
I think only the built-in REPL supports persistent history.
There was a problem hiding this comment.
That is true, it was discussed and decided against for increasing the API surface a few months ago.
The repl documentation has always been rather lacking. This is a first step towards making significant improvements.
|
Nits addressed! PTAL! |
|
@addaleax .. ping |
| ... }; | ||
| [Function] | ||
| ``` | ||
| var r = repl.start({prompt: '>', eval: myEval, writer: myWriter}); |
|
Still LGTM :) |
|
Thank you @addaleax ! Updated to fix those nits. Will get this landed. |
jasnell
added a commit
that referenced
this pull request
Jun 6, 2016
The repl documentation has always been rather lacking. This is a first step towards making significant improvements. PR-URL: #7002 Reviewed-By: Anna Henningsen <anna@addaleax.net>
|
Landed in c339c58 |
evanlucas
pushed a commit
that referenced
this pull request
Jun 15, 2016
The repl documentation has always been rather lacking. This is a first step towards making significant improvements. PR-URL: #7002 Reviewed-By: Anna Henningsen <anna@addaleax.net>
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 (repl)
Description of change
The repl documentation has always been rather lacking. This is a first step towards making significant improvements.
Refs: #3674
@nodejs/documentation