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 that readline write() is processed as input #8295

Closed
wants to merge 1 commit into from
Closed

doc: document that readline write() is processed as input #8295

wants to merge 1 commit into from

Conversation

jasnell
Copy link
Member

@jasnell jasnell commented Aug 27, 2016

Checklist
  • make -j4 test (UNIX), or vcbuild test nosign (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

Document that data written using readline.write() is processed as input.

Fixes: #4402

@jasnell jasnell added doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module. labels Aug 27, 2016
@addaleax
Copy link
Member

LGTM

@mscdex
Copy link
Contributor

mscdex commented Aug 27, 2016

Commit message is too long.

mscdex
mscdex reviewed Aug 27, 2016
View reviewed changes
doc/api/readline.md
@@ -315,6 +315,9 @@ rl.write('Delete this!');
rl.write(null, {ctrl: true, name: 'u'});
```

*Note*: The `rl.write()` method will write the data to the `readline` Interface
Copy link
Contributor

Choose a reason for hiding this comment

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

s/Interface/Interface's/

@cjihrig
Copy link
Contributor

cjihrig commented Aug 27, 2016

LGTM pending the nit.

jasnell added a commit that referenced this pull request Aug 29, 2016
@jasnell
doc: readline write() is processed as input
61fa50d 
Fixes: #4402
PR-URL: #8295
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@jasnell
Copy link
Member Author

jasnell commented Aug 29, 2016

Landed in 61fa50d

@jasnell jasnell closed this Aug 29, 2016
@Fishrock123 Fishrock123 mentioned this pull request Sep 6, 2016
Closed
Fishrock123 pushed a commit to Fishrock123/node that referenced this pull request Sep 8, 2016
@jasnell @Fishrock123
doc: readline write() is processed as input
eaec396 
Fixes: nodejs#4402
PR-URL: nodejs#8295
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Fishrock123 pushed a commit that referenced this pull request Sep 9, 2016
@jasnell @Fishrock123
doc: readline write() is processed as input
54d7613 
Fixes: #4402
PR-URL: #8295
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Sep 30, 2016
@jasnell
doc: readline write() is processed as input
68d182a 
Fixes: #4402
PR-URL: #8295
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Oct 10, 2016
@jasnell
doc: readline write() is processed as input
21834df 
Fixes: #4402
PR-URL: #8295
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
rvagg pushed a commit that referenced this pull request Oct 18, 2016
@jasnell @rvagg
doc: readline write() is processed as input
78fdb54 
Fixes: #4402
PR-URL: #8295
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Oct 26, 2016
@jasnell @MylesBorins
doc: readline write() is processed as input
e5f4367 
Fixes: #4402
PR-URL: #8295
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Oct 26, 2016
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. readline Issues 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.
5 participants
@jasnell @addaleax @mscdex @cjihrig @MylesBorins