Skip to content

Document readline keybindings - #31256

Closed
HarshithaKP wants to merge 5 commits into
nodejs:masterfrom
HarshithaKP:readline_keybindings
Closed

Document readline keybindings#31256
HarshithaKP wants to merge 5 commits into
nodejs:masterfrom
HarshithaKP:readline_keybindings

Conversation

@HarshithaKP

@HarshithaKPHarshithaKP commented Jan 8, 2020

Copy link
Copy Markdown
Member

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

Added readline keybindings table to document
@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Jan 8, 2020
@HarshithaKP

Copy link
Copy Markdown
MemberAuthor

cc: @shobhitchittora

Comment threaddoc/api/readline.md
Comment threaddoc/api/readline.md Outdated

@BridgeARBridgeAR left a comment

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.

@HarshithaKP thank you very much for working on this!

Comment threaddoc/api/readline.md
Comment threaddoc/api/readline.md Outdated
Comment threaddoc/api/readline.md Outdated
Comment threaddoc/api/readline.md Outdated
Comment threaddoc/api/readline.md Outdated
Comment threaddoc/api/readline.md
Comment threaddoc/api/readline.md Outdated
Comment threaddoc/api/readline.md
Comment threaddoc/api/readline.md Outdated
Comment threaddoc/api/readline.md

@BridgeARBridgeAR left a comment

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.

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

Comment threaddoc/api/readline.md
Comment threaddoc/api/readline.md
@BridgeARBridgeAR added the wip Issues and PRs that are still a work in progress. label Jan 9, 2020
@shobhitchittora

Copy link
Copy Markdown
Contributor

Thanks @HarshithaKP for picking this up.

@HarshithaKP

Copy link
Copy Markdown
MemberAuthor

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

BridgeAR
BridgeAR previously approved these changes Jan 10, 2020

@BridgeARBridgeAR left a comment

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.

LGTM. Just left some nits.

Comment threaddoc/api/repl.md Outdated
Comment threaddoc/api/repl.md Outdated
Comment threaddoc/api/repl.md Outdated
@BridgeARBridgeAR removed the wip Issues and PRs that are still a work in progress. label Jan 10, 2020
@BridgeAR
BridgeAR dismissed their stale reviewJanuary 10, 2020 15:03

The comments have to be addressed before this can land.

@jasnelljasnell left a comment

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.

LGTM with @BridgeAR's suggestions applied.

@BridgeARBridgeAR 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
This documents all readline key bindings. It is a rework of
#20825
PR-URL: #31256Fixes: #20814
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@BridgeAR

Copy link
Copy Markdown
Member

Landed in 027eaac 🎉

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

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

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

@targostargos 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
This documents all readline key bindings. It is a rework of
nodejs#20825
PR-URL: nodejs#31256Fixes: 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
This documents all readline key bindings. It is a rework of
#20825
PR-URL: #31256Fixes: #20814
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@targostargos mentioned this pull request May 2, 2020
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.

Projects

None yet

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