Improve 'which-key-special-keys' docstring
authorRobert Pluim <rpluim@gmail.com>
Fri, 15 Nov 2024 15:28:55 +0000 (16:28 +0100)
committerRobert Pluim <rpluim@gmail.com>
Fri, 15 Nov 2024 15:31:08 +0000 (16:31 +0100)
* lisp/which-key.el (which-key-special-keys): Explain the format
and use 'setopt'.

lisp/which-key.el

index fb0685cd3a92dbd3bc5f54a8e240845bfeb692cb..0118c0f74ef6a9c7124036ddd18eee82affa9ead 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")