Variable: eldoc-echo-area-prefer-doc-buffer

eldoc-echo-area-prefer-doc-buffer is a customizable variable defined in eldoc.el.gz.

Value

nil

Documentation

Prefer ElDoc's documentation buffer if it is displayed in some window.

If this variable's value is t, ElDoc will skip showing documentation in the echo area if the dedicated documentation buffer (displayed by eldoc-doc-buffer) is already displayed in some window. If the value is the symbol maybe, then the echo area is only skipped if the documentation needs to be truncated there.

This variable was added, or its default value changed, in Emacs 28.1.

View in manual

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/eldoc.el.gz
(defcustom eldoc-echo-area-prefer-doc-buffer nil
  "Prefer ElDoc's documentation buffer if it is displayed in some window.
If this variable's value is t, ElDoc will skip showing
documentation in the echo area if the dedicated documentation
buffer (displayed by `eldoc-doc-buffer') is already displayed in
some window.  If the value is the symbol `maybe', then the echo area
is only skipped if the documentation needs to be truncated there."
  :type '(choice (const :tag "Prefer ElDoc's documentation buffer" t)
                 (const :tag "Prefer echo area" nil)
                 (const :tag "Skip echo area if truncating" maybe))
  :version "28.1")