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.

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

doc: update readline key-bindings and TODO comments #33361

Closed
wants to merge 2 commits into from

Conversation

BridgeAR
Copy link
Member

doc: fix readline key binding documentation

The documentation for two key bindings was not correct.

lib: update TODO comments

This removes one TODO comment and adds another that indicates that
readline is currently not able to trigger specific escape sequences.

@nodejs/streams @nodejs/libuv does anyone know why the stream emits \b in case <ctrl><backspace> or <ctrl><shift><backspace> is used? I would expect it to be a different escape code and I tried to find documentation about it but I failed.

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

The documentation for two key bindings was not correct.

Signed-off-by: Ruben Bridgewater <[email protected]>
@nodejs-github-bot nodejs-github-bot added the readline Issues and PRs related to the built-in readline module. label May 11, 2020
This removes one TODO comment and adds another that indicates that
readline is currently not able to trigger specific escape sequences.

Signed-off-by: Ruben Bridgewater <[email protected]>
@BridgeAR
Copy link
Member Author

@nodejs/documentation PTAL

@BridgeAR
Copy link
Member Author

@nodejs/readline @nodejs/documentation this could use some reviews.

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 18, 2020
@addaleax
Copy link
Member

@BridgeAR I was just going to land this but noticed that the PR description and the commit messages mismatched – I assume the second message is supposed to be lib: update TODO comments, as written in the PR description, since it doesn’t touch the docs at all? If you want, I can fix that while landing, but I wanted to make sure.

@BridgeAR
Copy link
Member Author

@addaleax yes, that's fine for me. Feel free to change it

@addaleax
Copy link
Member

Landed in 4c4c226...9de08f7

@addaleax addaleax closed this May 20, 2020
addaleax pushed a commit that referenced this pull request May 20, 2020
The documentation for two key bindings was not correct.

Signed-off-by: Ruben Bridgewater <[email protected]>

PR-URL: #33361
Reviewed-By: Anto Aravinth <[email protected]>
addaleax pushed a commit that referenced this pull request May 20, 2020
This removes one TODO comment and adds another that indicates that
readline is currently not able to trigger specific escape sequences.

Signed-off-by: Ruben Bridgewater <[email protected]>

PR-URL: #33361
Reviewed-By: Anto Aravinth <[email protected]>
codebytere pushed a commit that referenced this pull request Jun 18, 2020
The documentation for two key bindings was not correct.

Signed-off-by: Ruben Bridgewater <[email protected]>

PR-URL: #33361
Reviewed-By: Anto Aravinth <[email protected]>
codebytere pushed a commit that referenced this pull request Jun 18, 2020
This removes one TODO comment and adds another that indicates that
readline is currently not able to trigger specific escape sequences.

Signed-off-by: Ruben Bridgewater <[email protected]>

PR-URL: #33361
Reviewed-By: Anto Aravinth <[email protected]>
@codebytere codebytere mentioned this pull request Jun 28, 2020
codebytere pushed a commit that referenced this pull request Jul 6, 2020
The documentation for two key bindings was not correct.

Signed-off-by: Ruben Bridgewater <[email protected]>

PR-URL: #33361
Reviewed-By: Anto Aravinth <[email protected]>
codebytere pushed a commit that referenced this pull request Jul 6, 2020
This removes one TODO comment and adds another that indicates that
readline is currently not able to trigger specific escape sequences.

Signed-off-by: Ruben Bridgewater <[email protected]>

PR-URL: #33361
Reviewed-By: Anto Aravinth <[email protected]>
@codebytere codebytere mentioned this pull request Jul 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. readline Issues and PRs related to the built-in readline module.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants