doc: document argument variant in the repl.md #10221
Conversation
nodejs-github-bot
added
dont-land-on-v7.x
doc
| @@ -411,6 +411,8 @@ added: v0.1.91 | |||
| `SIGINT` is received, i.e. `Ctrl+C` is pressed. This cannot be used together | |||
| with a custom `eval` function. Defaults to `false`. | |||
|
|
|||
| If `options` is a string, then it specifies the input prompt. | |||
There was a problem hiding this comment.
Can you elaborate here on what specifying the input prompt means? Perhaps with an example?
There was a problem hiding this comment.
I've tried to mirror others argument variant notes, for example in fs.md:
https://github.com/nodejs/node/blame/master/doc/api/fs.md#L473
https://github.com/nodejs/node/blame/master/doc/api/fs.md#L629
https://github.com/nodejs/node/blame/master/doc/api/fs.md#L676
https://github.com/nodejs/node/blame/master/doc/api/fs.md#L1364
https://github.com/nodejs/node/blame/master/doc/api/fs.md#L1916
Would a more verbose note be a duplicate of this explanation above?
Maybe, you could suggest the explanation? As for example, I could add some.
There was a problem hiding this comment.
@benjamingr I've added an example. Is it OK? If the elaboration is still needed, could you suggest one? I am not very good at English.
`options` in the `repl.start([options])` can be a string.
|
Yes, LGTM |
|
/cc @nodejs/documentation |
|
Landed in 50cb3a3 |
`options` in the `repl.start([options])` can be a string. Ref: #10160 PR-URL: #10221 Reviewed-By: Benjamin Gruenbaum <[email protected]>
`options` in the `repl.start([options])` can be a string. Ref: #10160 PR-URL: #10221 Reviewed-By: Benjamin Gruenbaum <[email protected]>
`options` in the `repl.start([options])` can be a string. Ref: nodejs#10160 PR-URL: nodejs#10221 Reviewed-By: Benjamin Gruenbaum <[email protected]>
`options` in the `repl.start([options])` can be a string. Ref: nodejs#10160 PR-URL: nodejs#10221 Reviewed-By: Benjamin Gruenbaum <[email protected]>
`options` in the `repl.start([options])` can be a string. Ref: #10160 PR-URL: #10221 Reviewed-By: Benjamin Gruenbaum <[email protected]>
`options` in the `repl.start([options])` can be a string. Ref: #10160 PR-URL: #10221 Reviewed-By: Benjamin Gruenbaum <[email protected]>
Checklist
Affected core subsystem(s)
doc, repl
Description of change
Document that
optionsin therepl.start([options])can be a string.This commit is separated from #10160 on demand for more careful evaluation.
Please, consider these facts:
String argument is already used in the doc examples here and here.
It is also used in the
repl.jscomment example.The chain from string argument to prompt and other options setting is this:
exports.start->REPLServer->Interfacein thereadline.js