Add a note to bind-key on the usage of the KEYMAP argument

Fixes https://github.com/jwiegley/use-package/issues/542
This commit is contained in:
John Wiegley 2017-12-04 15:55:41 -08:00
parent 2790bfc006
commit 277384d151

View file

@ -146,6 +146,13 @@ KEY-NAME may be a vector, in which case it is passed straight to
spelled-out keystrokes, e.g., \"C-c C-z\". See documentation of
`edmacro-mode' for details.
COMMAND must be an interactive function or lambda form.
KEYMAP, if present, should be a keymap and not a quoted symbol.
For example:
(bind-key \"M-h\" #'some-interactive-function my-mode-map)
If PREDICATE is non-nil, it is a form evaluated to determine when
a key should be bound. It must return non-nil in such cases.
Emacs can evaluate this form at any time that it does redisplay