diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2024-01-06 08:20:19 -0500 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2024-01-06 08:20:19 -0500 |
| commit | 5256b8dd4ebf163aa67ed50eb72168d965583caf (patch) | |
| tree | 62b0ff27c17137065a108144ba967380ee4cca20 /lisp/help.el | |
| parent | d9dabcacefad084cccaa32e4f5fffcb78728fa00 (diff) | |
| parent | bf7034048c16a95263e3f7c121dafbf1824ff28f (diff) | |
| download | emacs-5256b8dd4ebf163aa67ed50eb72168d965583caf.tar.gz | |
Merge from origin/emacs-29
bf7034048c1 ; * doc/emacs/custom.texi (Changing a Variable): Update e...
466d1c98a9e Fix icons.el when icon does not exist as a file
2a861124e89 ; Improve documentation of 'buffer-match-p'
dc9d02f8a01 * lisp/isearch.el (isearch-search-and-update): Let-bind '...
9308d9a74ab * src/comp.c (Fcomp__compile_ctxt_to_file): Fix hash tabl...
a2a6619b282 Provide decent documentation for 'help-quick'
ab66b749a27 ; * src/window.c (Fset_window_margins): Doc fix.
1a677d1429d treesit--pre-syntax-ppss: Fix args-out-of-range in intern...
Diffstat (limited to 'lisp/help.el')
| -rw-r--r-- | lisp/help.el | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/lisp/help.el b/lisp/help.el index a551dba5fe5..72a4f8a800d 100644 --- a/lisp/help.el +++ b/lisp/help.el @@ -171,7 +171,10 @@ buffer.") ;; Inspired by a mg fork (https://github.com/troglobit/mg) (defun help-quick () - "Display a quick-help buffer." + "Display a quick-help buffer showing popular commands and their bindings. +The window showing quick-help can be toggled using \\[help-quick-toggle]. +You can click on a key binding shown in the quick-help buffer to display +the documentation of the command bound to that key sequence." (interactive) (with-current-buffer (get-buffer-create "*Quick Help*") (let ((inhibit-read-only t) (padding 2) blocks) @@ -246,10 +249,14 @@ buffer.") ;; ... and shrink it immediately. (fit-window-to-buffer)) (message - (substitute-command-keys "Toggle the quick help buffer using \\[help-quick-toggle].")))) + (substitute-command-keys "Toggle display of quick-help buffer using \\[help-quick-toggle].")))) (defun help-quick-toggle () - "Toggle the quick-help window." + "Toggle display of a window showing popular commands and their bindings. +This toggles on and off the display of the quick-help buffer, which shows +popular commands and their bindings as produced by `help-quick'. +You can click on a key binding shown in the quick-help buffer to display +the documentation of the command bound to that key sequence." (interactive) (if (and-let* ((window (get-buffer-window "*Quick Help*"))) (quit-window t window)) |