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

Document readline keybindings #31256

Closed
wants to merge 5 commits into from
Closed

Document readline keybindings #31256

wants to merge 5 commits into from

Conversation

HarshithaKP
Copy link
Member

@HarshithaKP HarshithaKP commented Jan 8, 2020 •
edited

This is a rework of closed pr #20825
fixes: #20814

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@HarshithaKP
doc: readline keybindings
96872ea 
Added readline keybindings table to document
@HarshithaKP
doc: document readline keybindings
0de07fc 
This is a rework of closed pr nodejs#20825
fixes: nodejs#20814
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jan 8, 2020
@HarshithaKP
Copy link
Member Author

cc: @shobhitchittora

antsmartian
antsmartian reviewed Jan 8, 2020
View reviewed changes
doc/api/readline.md Outdated Show resolved Hide resolved
BridgeAR
BridgeAR reviewed Jan 8, 2020
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

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

@HarshithaKP thank you very much for working on this!

doc/api/readline.md Show resolved Hide resolved
doc/api/readline.md Outdated Show resolved Hide resolved
doc/api/readline.md Outdated Show resolved Hide resolved
doc/api/readline.md Outdated Show resolved Hide resolved
doc/api/readline.md Outdated Show resolved Hide resolved
doc/api/readline.md Show resolved Hide resolved
doc/api/readline.md Outdated Show resolved Hide resolved
doc/api/readline.md Show resolved Hide resolved
doc/api/readline.md Outdated Show resolved Hide resolved
doc/api/readline.md Show resolved Hide resolved
BridgeAR
BridgeAR reviewed Jan 8, 2020
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

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

Thanks for following up so quickly! This almost looks good to me.

doc/api/readline.md Show resolved Hide resolved
doc/api/readline.md Show resolved Hide resolved
@BridgeAR BridgeAR added the wip Issues and PRs that are still a work in progress. label Jan 9, 2020
@shobhitchittora
Copy link
Contributor

Thanks @HarshithaKP for picking this up.

@HarshithaKP
Copy link
Member Author

Ping @BridgeAR @antsmartian, I believe I addressed all the suggestions. Please have a look.

BridgeAR
BridgeAR previously approved these changes Jan 10, 2020
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

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

LGTM. Just left some nits.

doc/api/repl.md Outdated Show resolved Hide resolved
doc/api/repl.md Outdated Show resolved Hide resolved
doc/api/repl.md Outdated Show resolved Hide resolved
@BridgeAR BridgeAR removed the wip Issues and PRs that are still a work in progress. label Jan 10, 2020
@BridgeAR BridgeAR dismissed their stale review January 10, 2020 15:03

The comments have to be addressed before this can land.

jasnell
jasnell approved these changes Jan 12, 2020
View reviewed changes
Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

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

LGTM with @BridgeAR's suggestions applied.

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 13, 2020
BridgeAR pushed a commit that referenced this pull request Jan 13, 2020
@HarshithaKP @BridgeAR
doc: document readline key bindings
027eaac 
This documents all readline key bindings. It is a rework of
#20825

PR-URL: #31256
Fixes: #20814
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@BridgeAR
Copy link
Member

Landed in 027eaac 🎉

@BridgeAR BridgeAR closed this Jan 13, 2020
MylesBorins pushed a commit that referenced this pull request Jan 16, 2020
@HarshithaKP @MylesBorins
doc: document readline key bindings
b9aca78 
This documents all readline key bindings. It is a rework of
#20825

PR-URL: #31256
Fixes: #20814
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@codebytere codebytere mentioned this pull request Jan 16, 2020
Merged
codebytere pushed a commit that referenced this pull request Mar 14, 2020
@HarshithaKP @codebytere
doc: document readline key bindings
c72fff6 
This documents all readline key bindings. It is a rework of
#20825

PR-URL: #31256
Fixes: #20814
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This was referenced Mar 15, 2020
Closed
Closed
@addaleax
Copy link
Member

@codebytere Just fyi, this breaks make test for me on v12.x because there’s broken links in the documentation – I’ll still open backports for the other PRs as you suggested and try to make sure that tests pass as much as possible, but you may want to remove this commit from v12.x-staging

@targos
Copy link
Member

targos commented Apr 18, 2020

Let's wait for #31006 to land this one on v12.x

@targos targos removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. backport-blocked-v12.x labels Apr 25, 2020
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@HarshithaKP @targos
doc: document readline key bindings
cc9fa9f 
This documents all readline key bindings. It is a rework of
nodejs#20825

PR-URL: nodejs#31256
Fixes: nodejs#20814
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
targos pushed a commit that referenced this pull request Apr 28, 2020
@HarshithaKP @targos
doc: document readline key bindings
1d2565b 
This documents all readline key bindings. It is a rework of
#20825

PR-URL: #31256
Fixes: #20814
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@targos targos mentioned this pull request May 2, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@antsmartian antsmartian antsmartian left review comments

@jasnell jasnell jasnell approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

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

Successfully merging this pull request may close these issues.

doc: add doc for tty writes ( readline.js / REPL )
8 participants
@HarshithaKP @shobhitchittora @BridgeAR @addaleax @targos @jasnell @antsmartian @nodejs-github-bot