Expand docstring of which-key-mode

* lisp/which-key.el (which-key-mode): Expand docstring.

(cherry picked from commit 7372b2eb302f62536437b807f5220e5adfafbcf4)

diff --git a/etc/NEWS.30 b/etc/NEWS.30
index 50cdb88d78258b69ac32e9306093ab211e69b3a3..d21bb9a65b36a708289b8c3e48af0f3faaf3357d 100644 (file)
--- 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).
 
 \f
 * Incompatible Lisp Changes in Emacs 30.1

diff --git a/lisp/which-key.el b/lisp/which-key.el
index 973616ef1169aa16fbc0dc0d36a0af983d84fcf2..8ad2ba2c365dea4a3f63b5e0b66fc66e8296b5af 100644 (file)
--- 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