docs: update "Alt" key references to "Option" for better macOS alignment #89
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
Open
Updates documentation and CLI hint messages to refer to the "Option" key instead of "Alt". This provides a more intuitive experience for macOS users. Note: A clarification has been added to the README noting that the configuration parser still requires the use of the "Alt" keyword.
Contributor
|
Hm, I think the primary language we use should actually be consistent with the config. When I said I'd accept a docs PR I meant just a quick note about "Alt" means "Option" on native mac keyboards. People can figure out when you say "Alt" you mean "Option", but if you use "Option" in docs and then only accept "Alt" I think it creates a bad experience, even if there's a note about this. If we started accepting both (e.g. your PR to livesplit-hotkey merges) I'd consider this change for the docs. I was trying to figure out what most apps do; personally I rarely see anyone using the word "Option". I do see them use the symbol ⌥, which would also be fine for the docs, and doesn't have the problem that people expect it to work in a config file. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Updates documentation and CLI hint messages to refer to the "Option" key instead of "Alt". This provides a more intuitive experience for macOS users.
Note: A clarification has been added to the README noting that the configuration parser still requires the use of the "Alt" keyword.