[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] master c71fbbb 03/39: Add option to show docstrings in which-key

From: Justin Burkett
Subject: [elpa] master c71fbbb 03/39: Add option to show docstrings in which-key buffer
Date: Thu, 21 Jun 2018 15:48:12 -0400 (EDT)

branch: master
commit c71fbbbc3ec49bac4b73fe2700d633e3037c7ae4
Author: Justin Burkett <address@hidden>
Commit: Justin Burkett <address@hidden>

    Add option to show docstrings in which-key buffer
    Implements a simple version of the suggestion in #185
 which-key.el | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

diff --git a/which-key.el b/which-key.el
index 3400491..6ae8b72 100644
--- a/which-key.el
+++ b/which-key.el
@@ -215,6 +215,15 @@ only the first match is used to perform replacements from
   :group 'which-key
   :type 'boolean)
+(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."
+  :group 'which-key
+  :type 'boolean)
 (defcustom which-key-highlighted-command-list '()
   "A list of strings and/or cons cells used to highlight certain
 commands. If the element is a string, assume it is a regexp
@@ -1584,14 +1593,24 @@ alists. Returns a list (key separator description)."
              (local (eq (which-key--safe-lookup-key local-map (kbd keys))
                         (intern orig-desc)))
              (hl-face (which-key--highlight-face orig-desc))
-             (key-binding (which-key--maybe-replace (cons keys orig-desc))))
+             (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")))))
         (when (consp key-binding)
            (list (which-key--propertize-key
                   (which-key--extract-key (car key-binding)))
-                 (which-key--propertize-description
-                  (cdr key-binding) group local hl-face orig-desc))
+                 final-desc)
     (nreverse new-list)))

reply via email to

[Prev in Thread] Current Thread [Next in Thread]