Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: document argument variant in the repl.md #10221

Closed
wants to merge 1 commit into from
Closed

doc: document argument variant in the repl.md #10221

wants to merge 1 commit into from

Conversation

vsemozhetbyt
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt commented Dec 10, 2016 •
edited
Loading

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, repl

Description of change

Document that options in the repl.start([options]) can be a string.

This commit is separated from #10160 on demand for more careful evaluation.

Please, consider these facts:

  1. String argument is already used in the doc examples here and here.

  2. It is also used in the repl.js comment example.

  3. The chain from string argument to prompt and other options setting is this: exports.start -> REPLServer -> Interface in the readline.js

@nodejs-github-bot nodejs-github-bot added dont-land-on-v7.x doc Issues and PRs related to the documentations. repl Issues and PRs related to the REPL subsystem. labels Dec 10, 2016
benjamingr
benjamingr requested changes Dec 11, 2016
View reviewed changes
doc/api/repl.md
@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you elaborate here on what specifying the input prompt means? Perhaps with an example?

Copy link
Contributor Author

@vsemozhetbyt vsemozhetbyt Dec 11, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

@vsemozhetbyt vsemozhetbyt Dec 12, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

@vsemozhetbyt
doc: document argument variant in the repl.md
70a659f 
`options` in the `repl.start([options])` can be a string.
@benjamingr
Copy link
Member

Yes, LGTM

@vsemozhetbyt
Copy link
Contributor Author

/cc @nodejs/documentation

@lance
Copy link
Member

lance commented Dec 12, 2016

Landed in 50cb3a3

@lance lance closed this Dec 12, 2016
lance pushed a commit that referenced this pull request Dec 12, 2016
@vsemozhetbyt @lance
doc: document argument variant in the repl.md
50cb3a3 
`options` in the `repl.start([options])` can be a string.

Ref: #10160

PR-URL: #10221
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@vsemozhetbyt vsemozhetbyt deleted the repl.md.start branch December 12, 2016 21:38
@vsemozhetbyt vsemozhetbyt mentioned this pull request Dec 12, 2016
Closed
2 tasks
This was referenced Jan 19, 2017
Closed
Closed
targos pushed a commit that referenced this pull request Jan 28, 2017
@vsemozhetbyt @targos
doc: document argument variant in the repl.md
5880804 
`options` in the `repl.start([options])` can be a string.

Ref: #10160

PR-URL: #10221
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@italoacasas italoacasas mentioned this pull request Jan 29, 2017
Merged
italoacasas pushed a commit to italoacasas/node that referenced this pull request Jan 30, 2017
@vsemozhetbyt @italoacasas
doc: document argument variant in the repl.md
5250b33 
`options` in the `repl.start([options])` can be a string.

Ref: nodejs#10160

PR-URL: nodejs#10221
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
italoacasas pushed a commit to italoacasas/node that referenced this pull request Jan 30, 2017
@vsemozhetbyt @italoacasas
doc: document argument variant in the repl.md
aafb5de 
`options` in the `repl.start([options])` can be a string.

Ref: nodejs#10160

PR-URL: nodejs#10221
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 8, 2017
@vsemozhetbyt @MylesBorins
doc: document argument variant in the repl.md
daca360 
`options` in the `repl.start([options])` can be a string.

Ref: #10160

PR-URL: #10221
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 9, 2017
@vsemozhetbyt @MylesBorins
doc: document argument variant in the repl.md
8c487de 
`options` in the `repl.start([options])` can be a string.

Ref: #10160

PR-URL: #10221
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Mar 9, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benjamingr benjamingr benjamingr approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. repl Issues and PRs related to the REPL subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@vsemozhetbyt @benjamingr @lance @mscdex @MylesBorins @nodejs-github-bot