Added clarification to evil-define-key for escaping modifier keys #1856
Conversation
This file contains 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
It is useful to have clarification in the doc string for evil-define-key that it is necessary to escape modifiers keys for users that are accustomed to using functions like global-set-key or keymap-global-set where this is not necessary. This is also not made particularly clear in the define-key function itself, which is a legacy function.
axelf4
requested changes
Jan 10, 2024
There was a problem hiding this comment.
This is a good idea, but there are some things that I think could be reworded:
-
Users should just use
kbdinstead of typing out the key sequence representations by hand, unless they already know what they are doing. -
That the macro uses
define-keyis an implementation detail, could instead say roughly something like this:KEY is an internal Emacs representation of a key, as for
define-key. To bind key sequences that use modifier keys such as ..., convert the key sequences usingkbd. -
As
C/M/\are not Lisp symbols they should be quoted with double quotes instead of`...'.
axelf4
approved these changes
Jan 11, 2024
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.
It is useful to have clarification in the doc string for evil-define-key that it is necessary to escape modifiers keys, such as "C" and "M", for users that are accustomed to using functions like global-set-key or keymap-global-set where this is not necessary. This is also not made particularly clear in the define-key function itself, which is a legacy function.