From a701626753f6ef510fe42c2cb6640eed460aa78b Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Sat, 29 Jun 2024 00:56:11 +0200 Subject: [PATCH] Expand docstring of which-key-mode * lisp/which-key.el (which-key-mode): Expand docstring. (cherry picked from commit 7372b2eb302f62536437b807f5220e5adfafbcf4) --- etc/NEWS.30 | 7 +++++-- lisp/which-key.el | 10 +++++++++- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/etc/NEWS.30 b/etc/NEWS.30 index 50cdb88d782..d21bb9a65b3 100644 --- a/etc/NEWS.30 +++ b/etc/NEWS.30 @@ -2198,8 +2198,11 @@ in all buffers. +++ ** New package Which-Key The 'which-key' package from GNU ELPA is now included in Emacs. It -implements the 'which-key-mode' that displays a table of key bindings -upon entering a partial key chord and waiting for a moment. +implements the global minor mode 'which-key-mode' that displays a table +of key bindings upon entering a partial key chord and waiting for a +moment. For example, after enabling the minor mode, if you enter 'C-x' +and wait for one second, the minibuffer will expand with all available +key bindings that follow 'C-x' (or as many as space allows). * Incompatible Lisp Changes in Emacs 30.1 diff --git a/lisp/which-key.el b/lisp/which-key.el index 973616ef116..8ad2ba2c365 100644 --- a/lisp/which-key.el +++ b/lisp/which-key.el @@ -900,7 +900,15 @@ disable support." ;;;###autoload (define-minor-mode which-key-mode - "Toggle `which-key-mode'." + "Toggle `which-key-mode'. + +`which-key' is a minor mode that displays the key bindings following +your currently entered incomplete command (a prefix) in a popup. + +For example, after enabling the minor mode, if you enter \\`C-x' and +wait for one second (by default), the minibuffer will expand with all +available key bindings that follow \\`C-x' (or as many as space allows +given your settings)." :global t :group 'which-key :lighter which-key-lighter -- 2.39.2