From 52af077d6a56e20cf7a85986bbc10621a9fc44d9 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Wed, 2 Feb 2022 20:16:04 +0100 Subject: [PATCH] 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 eb024373e45..975be497e77 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")) -- 2.39.5