diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2023-07-06 11:42:01 +0300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2023-07-06 11:42:01 +0300 |
| commit | a30ebe7a5564d3352b9812b1e6fb85d7da6cd88d (patch) | |
| tree | eca7a1f0bb80b0332e246923977687f3852924fc /doc/lispref | |
| parent | c3fefb2b3ae098068bc03cc305b9181746d72751 (diff) | |
| download | emacs-a30ebe7a5564d3352b9812b1e6fb85d7da6cd88d.tar.gz emacs-a30ebe7a5564d3352b9812b1e6fb85d7da6cd88d.tar.bz2 emacs-a30ebe7a5564d3352b9812b1e6fb85d7da6cd88d.zip | |
; Improve documentation of key-binding commands
* doc/lispref/keymaps.texi (Key Binding Commands): Improve the
documentation of arguments expected by key binding commands.
* lisp/keymap.el (keymap-set, keymap-global-set)
(keymap-local-set, keymap-global-unset, keymap-local-unset)
(keymap-unset, key-parse): Doc fixes.
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/keymaps.texi | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index bbf7138b5be..ab862e75bb5 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi @@ -2070,7 +2070,16 @@ problematic suffixes/prefixes are @kbd{@key{ESC}}, @kbd{M-O} (which is really @section Commands for Binding Keys This section describes some convenient interactive interfaces for -changing key bindings. They work by calling @code{keymap-set}. +changing key bindings. They work by calling @code{keymap-set} +(@pxref{Changing key Bindings}). In interactive use, these commands +prompt for the argument @var{key} and expect the user to type a valid +key sequence; they also prompt for the @var{binding} of the key +sequence, and expect the name of a command (i.e., a symbol that +satisfies @code{commandp}, @pxref{Interactive Call}). When called +from Lisp, these commands expect @var{key} to be a string that +satisfies @code{key-valid-p} (@pxref{Key Sequences}), and +@var{binding} to be any Lisp object that is meaningful in a keymap +(@pxref{Key Lookup}). People often use @code{keymap-global-set} in their init files (@pxref{Init File}) for simple customization. For example, |