All: Normalize keyboard interaction markup #222
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <li><code>HOME</code>/<code>PAGE UP</code> - Move focus to the first item.</li> | ||
| <li><code>ESCAPE</code> - Close the menu.</li> | ||
| <li><code>ENTER</code>/<code>SPACE</code> - Select the currently focused item and close the menu.</li> | ||
| <li><code>ALT</code> + <code>UP</code>/<code>DOWN</code> - Toggle the visibility of the menu.</li> |
|
An em dash (—) is usually used in lists like this rather than a hyphen (-). I don't think there's a hard and fast rule though, so feel free to ignore that. This looks good. |
|
Added OPTION everywhere we have ALT. I tried using em dashes, but it didn't provide the same visual break since they're not used with spaces, so I switched back to colons. |
|
I like colons. This looks good. 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow up to discussion in #218. All key commands are now wrapped in code blocks. Key combos have spaces around
+to ease the mental parsing. There were a mix of colons and dashes between the keys and the description; I chose to normalize to the dashes since they provide additional visual spacing to ease the mental parsing.