]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve 'which-key-special-keys' docstring
authorRobert Pluim <rpluim@gmail.com>
Fri, 15 Nov 2024 15:28:55 +0000 (16:28 +0100)
committerEshel Yaron <me@eshelyaron.com>
Wed, 27 Nov 2024 19:48:24 +0000 (20:48 +0100)
* lisp/which-key.el (which-key-special-keys): Explain the format
and use 'setopt'.

(cherry picked from commit d4f81f716ae0ced72e26b403972adf95f02dbdd0)

lisp/which-key.el

index 1039f2427df2eb693dadceef54c973ae35c2a44a..6d3d5efdd035e25c7ecf0b91f1c7b131dacff076 100644 (file)
@@ -255,11 +255,12 @@ face to apply)."
   :package-version '(which-key . "1.0") :version "30.1")
 
 (defcustom which-key-special-keys '()
-  "These keys will automatically be truncated to one character.
-They also have `which-key-special-key-face' applied to them.  This
-is disabled by default.  An example configuration is
+  "Keys which will be truncated to their first character.
+They also have `which-key-special-key-face' applied to them.  This is
+disabled by default.  Format is a list of strings, an example
+configuration is:
 
-\(setq which-key-special-keys \\='(\"SPC\" \"TAB\" \"RET\" \"ESC\" \"DEL\")\)"
+\(setopt which-key-special-keys \\='(\"SPC\" \"TAB\" \"RET\" \"ESC\" \"DEL\")\)"
   :type '(repeat string)
   :package-version '(which-key . "1.0") :version "30.1")