From 277384d1512141b4577070f2dc50cd1560868272 Mon Sep 17 00:00:00 2001 From: John Wiegley Date: Mon, 4 Dec 2017 15:55:41 -0800 Subject: [PATCH] Add a note to `bind-key` on the usage of the KEYMAP argument Fixes https://github.com/jwiegley/use-package/issues/542 --- lisp/use-package/bind-key.el | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/lisp/use-package/bind-key.el b/lisp/use-package/bind-key.el index 1b11e6c8322..54961ecd96e 100644 --- a/lisp/use-package/bind-key.el +++ b/lisp/use-package/bind-key.el @@ -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 -- 2.39.2