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)))

diff --git a/src/keymap.c b/src/keymap.c
index be45d2be1e25fd3ed793b28aeba1bfdb2b7b8450..5324f7f0213435f69fccdfd11b6c472094afa766 100644 (file)
--- a/src/keymap.c
+++ b/src/keymap.c
@@ -1047,7 +1047,9 @@ DEF is anything that can be a key's definition:
     function definition, which should at that time be one of the above,
     or another symbol whose function definition is used, etc.),
  a cons (STRING . DEFN), meaning that DEFN is the definition
-    (DEFN should be a valid definition in its own right),
+    (DEFN should be a valid definition in its own right) and
+    STRING is the menu item name (which is used only if the containing
+    keymap has been created with a menu name, see `make-keymap'),
  or a cons (MAP . CHAR), meaning use definition of CHAR in keymap MAP,
  or an extended menu item definition.
  (See info node `(elisp)Extended Menu Items'.)