Skip to content

Conversation

jasnell
Copy link
Member

@jasnell jasnell commented May 26, 2016

Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
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

@jasnell jasnell added doc Issues and PRs related to the documentations. repl Issues and PRs related to the REPL subsystem. labels May 26, 2016
doc/api/repl.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

I know it’s only copied, but there should be a space between > and .save, right?

@addaleax
Copy link
Member

LGTM with a couple of comments

doc/api/repl.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

I think only the built-in REPL supports persistent history.

Copy link
Member

Choose a reason for hiding this comment

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

That is true, it was discussed and decided against for increasing the API surface a few months ago.

jasnell added 2 commits June 2, 2016 16:20
The repl documentation has always been rather lacking. This is
a first step towards making significant improvements.
@jasnell
Copy link
Member Author

jasnell commented Jun 2, 2016

Nits addressed! PTAL!

@jasnell
Copy link
Member Author

jasnell commented Jun 6, 2016

@addaleax .. ping

doc/api/repl.md Outdated
... };
[Function]
```
var r = repl.start({prompt: '>', eval: myEval, writer: myWriter});
Copy link
Member

@addaleax addaleax Jun 6, 2016

Choose a reason for hiding this comment

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

nit: const?

@addaleax
Copy link
Member

addaleax commented Jun 6, 2016

Still LGTM :)

@jasnell
Copy link
Member Author

jasnell commented Jun 6, 2016

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 <[email protected]>
@jasnell
Copy link
Member Author

jasnell commented Jun 6, 2016

Landed in c339c58

@jasnell jasnell closed this Jun 6, 2016
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 <[email protected]>
@evanlucas evanlucas mentioned this pull request Jun 16, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. repl Issues and PRs related to the REPL subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants