Skip to content

Commit

Permalink
doc: white space unification in repl.md
Browse files Browse the repository at this point in the history
Add an infix space in an argument list.
Change `>` into `> ` in code bits and output examples.
Explicitly clarify that default REPL prompt contains a trailing space.

PR-URL: #10244
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
vsemozhetbyt authored and evanlucas committed Jan 4, 2017
1 parent 37cb971 commit ae61232
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions doc/api/repl.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,10 +217,10 @@ following example, for instance, simply converts any input text to upper case:
```js
const repl = require('repl');

const r = repl.start({prompt: '>', eval: myEval, writer: myWriter});
const r = repl.start({prompt: '> ', eval: myEval, writer: myWriter});

function myEval(cmd, context, filename, callback) {
callback(null,cmd);
callback(null, cmd);
}

function myWriter(output) {
Expand Down Expand Up @@ -275,7 +275,7 @@ function initializeContext(context) {
context.m = 'test';
}

const r = repl.start({prompt: '>'});
const r = repl.start({prompt: '> '});
initializeContext(r.context);

r.on('reset', initializeContext);
Expand All @@ -286,15 +286,15 @@ reset to its initial value using the `.clear` command:

```js
$ ./node example.js
>m
> m
'test'
>m = 1
> m = 1
1
>m
> m
1
>.clear
> .clear
Clearing context...
>m
> m
'test'
>
```
Expand Down Expand Up @@ -371,8 +371,9 @@ within the action function for commands registered using the
added: v0.1.91
-->

* `options` {Object}
* `prompt` {String} The input prompt to display. Defaults to `> `.
* `options` {Object | String}
* `prompt` {String} The input prompt to display. Defaults to `> `
(with a trailing space).
* `input` {Readable} The Readable stream from which REPL input will be read.
Defaults to `process.stdin`.
* `output` {Writable} The Writable stream to which REPL output will be
Expand Down

0 comments on commit ae61232

Please sign in to comment.