branch: master
commit 0aae4c8634f5e282d7b0c2037d291ab926134730
Author: Justin Burkett <[email protected]>
Commit: Justin Burkett <[email protected]>
Improve which-key-show-docstrings option
Add setting docstring-only to omit command names. Add
which-key-docstring-face.
See #185
---
which-key.el | 46 +++++++++++++++++++++++++++++++++-------------
1 file changed, 33 insertions(+), 13 deletions(-)
diff --git a/which-key.el b/which-key.el
index 6ae8b72..1f4bfa1 100644
--- a/which-key.el
+++ b/which-key.el
@@ -218,11 +218,15 @@ only the first match is used to perform replacements from
(defcustom which-key-show-docstrings nil
"If non-nil, show each command's docstring next to the command
in the which-key buffer. This will only display the docstring up
-to the first line break. You probably also want to adjust
-`which-key-max-description-length' at the same time if you use
-this feature."
+to the first line break. If you set this variable to the symbol
+docstring-only, then the command's name with be omitted. You
+probably also want to adjust `which-key-max-description-length'
+at the same time if you use this feature."
:group 'which-key
- :type 'boolean)
+ :type '(radio
+ (const :tag "Do not show docstrings" nil)
+ (const :tag "Add docstring to command names" t)
+ (const :tag "Replace command name with docstring" docstring-only)))
(defcustom which-key-highlighted-command-list '()
"A list of strings and/or cons cells used to highlight certain
@@ -566,6 +570,11 @@ and it matches a string in
`which-key-highlighted-command-list'."
"Face for special keys (SPC, TAB, RET)"
:group 'which-key-faces)
+(defface which-key-docstring-face
+ '((t . (:inherit which-key-note-face)))
+ "Face for docstrings"
+ :group 'which-key-faces)
+
;;;; Custom popup
(defcustom which-key-custom-popup-max-dimensions-function nil
@@ -1574,6 +1583,25 @@ ORIGINAL-DESCRIPTION is the description given by
(match-string 1 key-str)
(car (last (split-string key-str " ")))))))
+(defun which-key--maybe-add-docstring (current original)
+ "Maybe concat a docstring to CURRENT and return result.
+Specifically, do this if ORIGINAL is a command with a docstring
+and `which-key-show-docstrings' is non-nil. If
+`which-key-show-docstrings' is the symbol docstring-only, just
+return the docstring."
+ (let* ((orig-sym (intern original))
+ (doc (when (commandp orig-sym)
+ (documentation orig-sym)))
+ (docstring (when doc
+ (propertize (car (split-string doc "\n"))
+ 'face 'which-key-docstring-face))))
+ (cond ((not (and which-key-show-docstrings docstring))
+ current)
+ ((eq which-key-show-docstrings 'docstring-only)
+ docstring)
+ (t
+ (format "%s %s" current docstring)))))
+
(defun which-key--format-and-replace (unformatted)
"Take a list of (key . desc) cons cells in UNFORMATTED, add
faces and perform replacements according to the three replacement
@@ -1596,15 +1624,7 @@ alists. Returns a list (key separator description)."
(key-binding (which-key--maybe-replace (cons keys orig-desc)))
(final-desc (which-key--propertize-description
(cdr key-binding) group local hl-face orig-desc)))
- (when (and which-key-show-docstrings
- (commandp (intern orig-desc))
- (documentation (intern orig-desc)))
- (setq final-desc
- (format "%s %s"
- final-desc
- (car
- (split-string
- (documentation (intern orig-desc)) "\n")))))
+ (setq final-desc (which-key--maybe-add-docstring final-desc orig-desc))
(when (consp key-binding)
(push
(list (which-key--propertize-key
