]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve the describe-key doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Wed, 2 Feb 2022 19:16:04 +0000 (20:16 +0100)
committerLars Ingebrigtsen <larsi@gnus.org>
Wed, 2 Feb 2022 19:16:04 +0000 (20:16 +0100)
* lisp/help.el (describe-key): Say something about prefix keys
(bug#33320).

lisp/help.el

index eb024373e4519b02d532b8d6fd378142b185678e..975be497e7757e44e99023cd4294798e57289761 100644 (file)
@@ -907,6 +907,12 @@ While reading KEY-LIST interactively, this command temporarily enables
 menu items or tool-bar buttons that are disabled to allow getting help
 on them.
 
+Interactively, this command can't describe prefix commands, but
+will always wait for the user to type the complete key sequence.
+For instance, entering \"C-x\" will wait until the command has
+been completed, but `M-: (describe-key (kbd \"C-x\")) RET' will
+tell you what this prefix command is bound to.
+
 BUFFER is the buffer in which to lookup those keys; it defaults to the
 current buffer."
   (declare (advertised-calling-convention (key-list &optional buffer) "27.1"))