Skip to content

Commit

Permalink
Added clarification to evil-define-key for escaping modifier keys (#1856
Browse files Browse the repository at this point in the history
)

* Added clarification to evil-define-key for escaping modifier keys

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.

* Fixed poor wording and used kdb in place of escape sequence
  • Loading branch information
Naokotani committed Jan 11, 2024
1 parent 6ca32ca commit 59774e3
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion evil-core.el
Original file line number Diff line number Diff line change
Expand Up @@ -958,7 +958,14 @@ the following lead to identical bindings:
The symbol `local' may also be used, which corresponds to using
`evil-local-set-key'. If a quoted symbol is used that is not
`global' or `local', it is assumed to be the name of a minor
mode, in which case `evil-define-minor-mode-key' is used."
mode, in which case `evil-define-minor-mode-key' is used.
KEY is an internal Emacs representation of a key, as for
`define-key'. To bind key sequences that use modifier keys such
as \"C-a\" or \"M-a\", convert the key sequences using `kbd'.
For example:
(evil-define-key \\='normal foo-map (kbd \"C-a\") \\='bar)"
(declare (indent defun))
(cond
((member keymap '('global 'local))
Expand Down

0 comments on commit 59774e3

Please sign in to comment.