From: Robert Pluim <rpluim@gmail.com>
Date: Fri, 15 Nov 2024 15:28:55 +0000 (+0100)
Subject: Improve 'which-key-special-keys' docstring
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=6b523bbe6c9ffe6c6449c5cadad5db7730917286;p=emacs.git

Improve 'which-key-special-keys' docstring

* lisp/which-key.el (which-key-special-keys): Explain the format
and use 'setopt'.

(cherry picked from commit d4f81f716ae0ced72e26b403972adf95f02dbdd0)
---

diff --git a/lisp/which-key.el b/lisp/which-key.el
index 1039f2427df..6d3d5efdd03 100644
--- a/lisp/which-key.el
+++ b/lisp/which-key.el
@@ -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")