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

repl: standardize Control key indications #35270

Merged
merged 1 commit into from
Sep 28, 2020
Merged

Conversation

Trott
Copy link
Member

@Trott Trott commented Sep 19, 2020

Throughout our messages and docs, we refer to the Control key in a
surprisingly varied number of ways:

  • Control
  • Ctrl
  • Cntl
  • varied capitalization on the above (e.g., ctrl vs. Ctrl)

Then, in key combinations:

  • One of the items from the previous list followed by -
  • ... or followed by +
  • ... surrounded or not by < and >
  • ... and inside backticks or not
  • ... or just ^

This is the start of standardization on the formulation recommended by
the Microsoft Style Guide (e.g., Ctrl+C).

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

@nodejs-github-bot nodejs-github-bot added the repl Issues and PRs related to the REPL subsystem. label Sep 19, 2020
@Trott Trott added request-ci Add this label to start a Jenkins CI on a PR. and removed repl Issues and PRs related to the REPL subsystem. labels Sep 19, 2020
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 19, 2020
@nodejs-github-bot
Copy link
Collaborator

@devsnek
Copy link
Member

devsnek commented Sep 19, 2020

I'm not sure if our markdown renderer supports this but Ctrl + C would be nice. If it doesn't we can also do it manually: https://snek.dev/keyboard.html

@Trott
Copy link
Member Author

Trott commented Sep 21, 2020

I'm not sure if our markdown renderer supports this but Ctrl + C would be nice. If it doesn't we can also do it manually: https://snek.dev/keyboard.html

I like a lot of things about that approach, but I am somewhat conflicted and would prefer to keep the "standardize the abbreviation we use for the Control key" separate from "figure out how we render/markup keyboard keys". I'd be happy to open a different PR for that second one, unless you want to do it.

@Trott
Copy link
Member Author

Trott commented Sep 21, 2020

@nodejs/documentation

@Trott Trott requested review from BridgeAR and addaleax and removed request for BridgeAR and addaleax September 22, 2020 14:09
@Trott
Copy link
Member Author

Trott commented Sep 22, 2020

@nodejs/repl

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, those are definitely clearer than e.g., ^C :-)

@Trott Trott added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 27, 2020
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 27, 2020
@nodejs-github-bot
Copy link
Collaborator

Throughout our messages and docs, we refer to the Control key in a
surprisingly varied number of ways:

* Control
* Ctrl
* Cntl
* varied capitalization on the above (e.g., ctrl vs. Ctrl)

Then, in key combinations:

* One of the items from the previous list followed by `-`
* ... or followed by `+`
* ... surrounded or not by `<` and `>`
* ... and inside backticks or not
* ... or just `^`

This is the start of standardization on the formulation recommended by
the Microsoft Style Guide (e.g., **Ctrl+C**).

PR-URL: nodejs#35270
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@Trott
Copy link
Member Author

Trott commented Sep 28, 2020

Landed in eec4a5b

@Trott Trott merged commit eec4a5b into nodejs:master Sep 28, 2020
@Trott Trott deleted the repl-Ctrl-plus branch September 28, 2020 13:56
MylesBorins pushed a commit that referenced this pull request Sep 29, 2020
Throughout our messages and docs, we refer to the Control key in a
surprisingly varied number of ways:

* Control
* Ctrl
* Cntl
* varied capitalization on the above (e.g., ctrl vs. Ctrl)

Then, in key combinations:

* One of the items from the previous list followed by `-`
* ... or followed by `+`
* ... surrounded or not by `<` and `>`
* ... and inside backticks or not
* ... or just `^`

This is the start of standardization on the formulation recommended by
the Microsoft Style Guide (e.g., **Ctrl+C**).

PR-URL: #35270
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@MylesBorins MylesBorins mentioned this pull request Sep 29, 2020
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
Throughout our messages and docs, we refer to the Control key in a
surprisingly varied number of ways:

* Control
* Ctrl
* Cntl
* varied capitalization on the above (e.g., ctrl vs. Ctrl)

Then, in key combinations:

* One of the items from the previous list followed by `-`
* ... or followed by `+`
* ... surrounded or not by `<` and `>`
* ... and inside backticks or not
* ... or just `^`

This is the start of standardization on the formulation recommended by
the Microsoft Style Guide (e.g., **Ctrl+C**).

PR-URL: nodejs#35270
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants