Variable: eldoc-echo-area-use-multiline-p

eldoc-echo-area-use-multiline-p is a customizable variable defined in eldoc.el.gz.

Value

truncate-sym-name-if-fit

Documentation

Allow long ElDoc doc strings to resize echo area display.

If the value is t, never attempt to truncate messages, even if the echo area must be resized to fit. In that case, Emacs will resize the mini-window up to the limit set by max-mini-window-height.

If the value is a positive number, it is used to calculate a number of screen lines of documentation that ElDoc is allowed to put in the echo area. A positive integer specifies the maximum number of lines directly, while a floating-point number specifies the number of screen lines as a fraction of the echo area frame's height.

If the value is the symbol truncate-sym-name-if-fit, the part of the doc string that represents a symbol's name may be truncated if it will enable the rest of the doc string to fit on a single line, without resizing the echo area.

If the value is nil, a doc string is always truncated to fit in a single screen line of echo-area display.

Any resizing of the echo area additionally respects max-mini-window-height.

View in manual

Probably introduced at or before Emacs version 28.1.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/eldoc.el.gz
(defcustom eldoc-echo-area-use-multiline-p 'truncate-sym-name-if-fit
  "Allow long ElDoc doc strings to resize echo area display.
If the value is t, never attempt to truncate messages, even if the
echo area must be resized to fit.  In that case, Emacs will resize
the mini-window up to the limit set by `max-mini-window-height'.

If the value is a positive number, it is used to calculate a
number of screen lines of documentation that ElDoc is allowed to
put in the echo area.  A positive integer specifies the maximum
number of lines directly, while a floating-point number specifies
the number of screen lines as a fraction of the echo area frame's
height.

If the value is the symbol `truncate-sym-name-if-fit', the part of
the doc string that represents a symbol's name may be truncated
if it will enable the rest of the doc string to fit on a single
line, without resizing the echo area.

If the value is nil, a doc string is always truncated to fit in a
single screen line of echo-area display.

Any resizing of the echo area additionally respects
`max-mini-window-height'."
  :type '(radio (const   :tag "Always" t)
                (float   :tag "Fraction of frame height" 0.25)
                (integer :tag "Number of lines" 5)
                (const   :tag "Never" nil)
                (const   :tag "Yes, but ask major-mode to truncate
 symbol names if it will\ enable argument list to fit on one
 line" truncate-sym-name-if-fit)))