Skip to content

doc: general improvements to repl.md copy - #7002

Closed
jasnell wants to merge 3 commits into
nodejs:masterfrom
jasnell:doc-repl-copy
Closed

doc: general improvements to repl.md copy#7002
jasnell wants to merge 3 commits into
nodejs:masterfrom
jasnell:doc-repl-copy

Conversation

@jasnell

Copy link
Copy Markdown
Member
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

@jasnelljasnell added doc Issues and PRs related to the documentations. repl Issues and PRs related to the REPL subsystem. labels May 26, 2016
Comment threaddoc/api/repl.md Outdated

Copy link
Copy Markdown
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
Copy Markdown
Member

LGTM with a couple of comments

Comment threaddoc/api/repl.md Outdated

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
MemberAuthor

Nits addressed! PTAL!

@jasnell

Copy link
Copy Markdown
MemberAuthor

@addaleax .. ping

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

@addaleaxaddaleaxJun 6, 2016

Copy link
Copy Markdown
Member

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
Copy Markdown
Member

Still LGTM :)

@jasnell

Copy link
Copy Markdown
MemberAuthor

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

Copy link
Copy Markdown
MemberAuthor

Landed in c339c58

@jasnelljasnell 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 <anna@addaleax.net>
@evanlucasevanlucas mentioned this pull request Jun 16, 2016
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.replIssues and PRs related to the REPL subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@jasnell@addaleax@lance@benjamingr@MylesBorins