]> code.delx.au - gnu-emacs/commitdiff
Doc fix
authorLars Ingebrigtsen <larsi@gnus.org>
Fri, 29 Apr 2016 22:54:13 +0000 (00:54 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sun, 1 May 2016 17:27:10 +0000 (19:27 +0200)
* src/keymap.c (Fdefine_prefix_command): Clarify doc string
slightly (bug#18092).

(cherry picked from commit 6b769c81d024f7eeb90b167e7df6f87d859614d4)

src/keymap.c

index 8ab4c6c27ae5e5e542d6dadf88016b7235336265..c975aad27d8d8d22009e155fc72a09be78dcdc1e 100644 (file)
@@ -1737,10 +1737,12 @@ bindings; see the description of `lookup-key' for more details about this.  */)
 
 DEFUN ("define-prefix-command", Fdefine_prefix_command, Sdefine_prefix_command, 1, 3, 0,
        doc: /* Define COMMAND as a prefix command.  COMMAND should be a symbol.
-A new sparse keymap is stored as COMMAND's function definition and its value.
-If a second optional argument MAPVAR is given, the map is stored as
-its value instead of as COMMAND's value; but COMMAND is still defined
-as a function.
+A new sparse keymap is stored as COMMAND's function definition and its
+value.
+This prepares COMMAND for use as a prefix key's binding.
+If a second optional argument MAPVAR is given, it should be a symbol.
+The map is then stored as MAPVAR's value instead of as COMMAND's
+value; but COMMAND is still defined as a function.
 The third optional argument NAME, if given, supplies a menu name
 string for the map.  This is required to use the keymap as a menu.
 This function returns COMMAND.  */)