diff options
| author | Robert Pluim | 2024-11-15 16:28:55 +0100 |
|---|---|---|
| committer | Robert Pluim | 2024-11-15 16:31:08 +0100 |
| commit | d4f81f716ae0ced72e26b403972adf95f02dbdd0 (patch) | |
| tree | 30929850ab923f28e957d296d189746ed17162ab | |
| parent | 926d47ab2ca72054f1a5c774916927160a839dc1 (diff) | |
| download | emacs-d4f81f716ae0ced72e26b403972adf95f02dbdd0.tar.gz emacs-d4f81f716ae0ced72e26b403972adf95f02dbdd0.zip | |
Improve 'which-key-special-keys' docstring
* lisp/which-key.el (which-key-special-keys): Explain the format
and use 'setopt'.
| -rw-r--r-- | lisp/which-key.el | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/lisp/which-key.el b/lisp/which-key.el index fb0685cd3a9..0118c0f74ef 100644 --- a/lisp/which-key.el +++ b/lisp/which-key.el | |||
| @@ -255,11 +255,12 @@ face to apply)." | |||
| 255 | :package-version '(which-key . "1.0") :version "30.1") | 255 | :package-version '(which-key . "1.0") :version "30.1") |
| 256 | 256 | ||
| 257 | (defcustom which-key-special-keys '() | 257 | (defcustom which-key-special-keys '() |
| 258 | "These keys will automatically be truncated to one character. | 258 | "Keys which will be truncated to their first character. |
| 259 | They also have `which-key-special-key-face' applied to them. This | 259 | They also have `which-key-special-key-face' applied to them. This is |
| 260 | is disabled by default. An example configuration is | 260 | disabled by default. Format is a list of strings, an example |
| 261 | configuration is: | ||
| 261 | 262 | ||
| 262 | \(setq which-key-special-keys \\='(\"SPC\" \"TAB\" \"RET\" \"ESC\" \"DEL\")\)" | 263 | \(setopt which-key-special-keys \\='(\"SPC\" \"TAB\" \"RET\" \"ESC\" \"DEL\")\)" |
| 263 | :type '(repeat string) | 264 | :type '(repeat string) |
| 264 | :package-version '(which-key . "1.0") :version "30.1") | 265 | :package-version '(which-key . "1.0") :version "30.1") |
| 265 | 266 | ||