Variable: which-key-show-docstrings

which-key-show-docstrings is a customizable variable defined in which-key.el.gz.

Value

nil

Documentation

If non-nil, show each command's docstring in the which-key popup.

This will only display the docstring up 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.

This variable was added, or its default value changed, in which-key version 1.0.

Source Code

;; Defined in /usr/src/emacs/lisp/which-key.el.gz
(defcustom which-key-show-docstrings nil
  "If non-nil, show each command's docstring in the which-key popup.
This will only display the docstring up 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."
  :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))
  :package-version '(which-key . "1.0") :version "30.1")