Skip to content

doc: general improvements to readline.md copy - #7022

Closed
jasnell wants to merge 2 commits into
nodejs:masterfrom
jasnell:doc-readline-copy
Closed

doc: general improvements to readline.md copy#7022
jasnell wants to merge 2 commits into
nodejs:masterfrom
jasnell:doc-readline-copy

Conversation

@jasnell

@jasnelljasnell commented May 27, 2016

Copy link
Copy Markdown
Member
Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc (readline)

Description of change

General improvements to readline.md copy

@nodejs/documentation

@jasnelljasnell added doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module. labels May 27, 2016
addaleax
addaleax reviewed May 27, 2016
View reviewed changes
Comment threaddoc/api/readline.md Outdated

@addaleaxaddaleaxMay 27, 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.

Might want to explain here that this is because the interface waits for data from the input stream? Feel free to omit if you think that would go too much into detail.

@addaleax

addaleax commented May 27, 2016

Copy link
Copy Markdown
Member

See also: #6996 … Maybe cherry-pick that into this PR as a second commit?

@jasnell

jasnell commented May 27, 2016•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

If #6996 lands first I'll rebase this on it. If this lands first, I'll cherry pick it in

@jasnell

jasnell commented May 27, 2016

Copy link
Copy Markdown
MemberAuthor

Nits fixed!

Fishrock123
Fishrock123 reviewed May 27, 2016
View reviewed changes
Comment threaddoc/api/readline.md Outdated

@Fishrock123Fishrock123May 27, 2016•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe 'Tiny> '? (No need to change if you'd like to keep the ohai though imo)

@jasnelljasnellMay 27, 2016

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

meh, I'm good with ohai for the example

@jasnell
jasnellforce-pushed the doc-readline-copy branch from 80f7270 to 95383e0CompareJune 2, 2016 23:32
@jasnell

jasnell commented Jun 2, 2016

Copy link
Copy Markdown
MemberAuthor

Nits addressed. @nodejs/documentation ... one final look please :-)

@jasnell

jasnell commented Jun 6, 2016

Copy link
Copy Markdown
MemberAuthor

ping @nodejs/documentation

@benjamingr

benjamingr commented Jun 6, 2016

Copy link
Copy Markdown
Member

LGTM

@jasnell
jasnellforce-pushed the doc-readline-copy branch from 95383e0 to da86df3CompareJune 6, 2016 19:46
@jasnell
jasnellforce-pushed the doc-readline-copy branch from da86df3 to 1d7e233CompareJune 6, 2016 19:54
@jasnell

jasnell commented Jun 6, 2016

Copy link
Copy Markdown
MemberAuthor

Rebased to resolve conflicts after the added details were added

@jasnell
doc: clarify rl.question callback args
20ff400
Clarify that readline's rl.question() callback does not
use the err back pattern.
Fixes: nodejs#4833
jasnell added a commit that referenced this pull request Jun 7, 2016
@jasnell
doc: general improvements to readline.md copy
ed8b600
PR-URL: #7022
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
jasnell added a commit that referenced this pull request Jun 7, 2016
@jasnell
doc: clarify rl.question callback args
c300ba2
Clarify that readline's rl.question() callback does not
use the err back pattern.
Fixes: #4833
PR-URL: #7022
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@jasnell

jasnell commented Jun 7, 2016

Copy link
Copy Markdown
MemberAuthor

Landed in ed8b600 and c300ba2

@jasnelljasnell closed this Jun 7, 2016
evanlucas pushed a commit that referenced this pull request Jun 15, 2016
@jasnell@evanlucas
doc: general improvements to readline.md copy
70f2f35
PR-URL: #7022
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
evanlucas pushed a commit that referenced this pull request Jun 15, 2016
@jasnell@evanlucas
doc: clarify rl.question callback args
d31f728
Clarify that readline's rl.question() callback does not
use the err back pattern.
Fixes: #4833
PR-URL: #7022
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@evanlucasevanlucas mentioned this pull request Jun 16, 2016
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.readlineIssues and PRs related to the built-in readline module.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@jasnell@addaleax@benjamingr@Fishrock123@vsemozhetbyt@MylesBorins