procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Expand docstring of which-key-mode

Browse source 
* lisp/which-key.el (which-key-mode): Expand docstring.
This commit is contained in:
Stefan Kangas 2024-06-29 00:56:11 +02:00
parent df0eb5be1e
commit 7372b2eb30
2 changed files with 14 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
etc/NEWS
View file

@ -2112,8 +2112,11 @@ in all buffers.
+++ +++
** New package Which-Key ** New package Which-Key
The 'which-key' package from GNU ELPA is now included in Emacs. It 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 implements the global minor mode 'which-key-mode' that displays a table
upon entering a partial key chord and waiting for a moment. 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 * Incompatible Lisp Changes in Emacs 30.1

10
lisp/which-key.el
View file

@ -900,7 +900,15 @@ disable support."
;;;###autoload ;;;###autoload
(define-minor-mode which-key-mode (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 :global t
:group 'which-key :group 'which-key
:lighter which-key-lighter :lighter which-key-lighter