-
Notifications
You must be signed in to change notification settings - Fork 30k
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
Conversation
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 |
51bf656
to
9a1c996
Compare
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. |
@nodejs/documentation |
@nodejs/repl |
There was a problem hiding this 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
:-)
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>
9a1c996
to
eec4a5b
Compare
Landed in eec4a5b |
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>
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>
Throughout our messages and docs, we refer to the Control key in a
surprisingly varied number of ways:
Then, in key combinations:
-
+
<
and>
^
This is the start of standardization on the formulation recommended by
the Microsoft Style Guide (e.g., Ctrl+C).
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes