master 52af077d6a 2/2: Improve the describe-key doc string

[Lars Ingebrigtsen]

branch: master
commit 52af077d6a56e20cf7a85986bbc10621a9fc44d9
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>

    Improve the describe-key doc string
    
    * lisp/help.el (describe-key): Say something about prefix keys
    (bug#33320).
---
 lisp/help.el | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/lisp/help.el b/lisp/help.el
index eb024373e4..975be497e7 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -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"))