diff options
| author | Lars Ingebrigtsen | 2021-10-14 19:53:00 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2021-10-14 19:53:04 +0200 |
| commit | 732666b86ec7c415a4d7246db3e9709a95bebf95 (patch) | |
| tree | 339f4d30d2e719862411cdff6f9e5a038889fb2f /src/keymap.c | |
| parent | 40f20109711db5747da982e118a4497235351544 (diff) | |
| download | emacs-732666b86ec7c415a4d7246db3e9709a95bebf95.tar.gz emacs-732666b86ec7c415a4d7246db3e9709a95bebf95.zip | |
define-key doc string improvement
* src/keymap.c (Fdefine_key): Explain what the STRING is used for.
(local-set-key "\C-c\C-c"
(define-keymap
:name "Zot"
"a" '("foo" . ignore)
"b" '("gazonk" . ignore)))
Diffstat (limited to 'src/keymap.c')
| -rw-r--r-- | src/keymap.c | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/keymap.c b/src/keymap.c index be45d2be1e2..5324f7f0213 100644 --- a/src/keymap.c +++ b/src/keymap.c | |||
| @@ -1047,7 +1047,9 @@ DEF is anything that can be a key's definition: | |||
| 1047 | function definition, which should at that time be one of the above, | 1047 | function definition, which should at that time be one of the above, |
| 1048 | or another symbol whose function definition is used, etc.), | 1048 | or another symbol whose function definition is used, etc.), |
| 1049 | a cons (STRING . DEFN), meaning that DEFN is the definition | 1049 | a cons (STRING . DEFN), meaning that DEFN is the definition |
| 1050 | (DEFN should be a valid definition in its own right), | 1050 | (DEFN should be a valid definition in its own right) and |
| 1051 | STRING is the menu item name (which is used only if the containing | ||
| 1052 | keymap has been created with a menu name, see `make-keymap'), | ||
| 1051 | or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP, | 1053 | or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP, |
| 1052 | or an extended menu item definition. | 1054 | or an extended menu item definition. |
| 1053 | (See info node `(elisp)Extended Menu Items'.) | 1055 | (See info node `(elisp)Extended Menu Items'.) |