summaryrefslogtreecommitdiff
path: root/doc/lispref/help.texi
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2022-05-13 15:54:16 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2022-05-13 15:54:16 +0200
commitebfec5c119e5758de0ec9ba1136f3e17268da5c3 (patch)
treef4414aabd6ce8cc7c9c6afbad30e0b0b866d3e5a /doc/lispref/help.texi
parent2ec9f025d242cf28098cf01c532d0cf4e6bd1661 (diff)
downloademacs-ebfec5c119e5758de0ec9ba1136f3e17268da5c3.tar.gz
Allow substitute-command-keys to include menus in \{...} output
* doc/lispref/help.texi (Keys in Documentation): Document it. * lisp/help.el (substitute-command-keys): Add an argument to include menus in the \{...-map} output (bug#24236).
Diffstat (limited to 'doc/lispref/help.texi')
-rw-r--r--doc/lispref/help.texi5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi
index f029a1c97cc..9b2d63dcbd9 100644
--- a/doc/lispref/help.texi
+++ b/doc/lispref/help.texi
@@ -390,7 +390,7 @@ quotes. You can customize it freely according to your personal
preference.
@end defopt
-@defun substitute-command-keys string &optional no-face
+@defun substitute-command-keys string &optional no-face include-menus
@vindex help-key-binding@r{ (face)}
This function scans @var{string} for the above special sequences and
replaces them by what they stand for, returning the result as a string.
@@ -440,6 +440,9 @@ RET minibuffer-complete-and-exit
C-g abort-recursive-edit
"
+The keymap description will normally exclude menu items, but it
+@var{include-menus} is non-@code{nil}, include them.
+
@group
(substitute-command-keys
"To abort a recursive edit from the minibuffer, type \