Variable: cider-docstring-max-lines

cider-docstring-max-lines is a customizable variable defined in cider-docstring.el.

Value

20

Documentation

The maximum number of docstring lines that will be rendered in a UI widget (or the echo area).

Note that cider-docstring will trim thing smartly, for Java doc comments:
* First, the whole doc comment will be attempted to be rendered.
* If that exceeds cider-docstring-max-lines,
  we will use only the first sentence and the block tags
  (that is, the params/throws/returns info).
* If that exceeds cider-docstring-max-lines, we will use only the block tags.
* If that exceeds cider-docstring-max-lines, we will use only the first sentence.

This variable was added, or its default value changed, in cider version 1.8.0.

Source Code

;; Defined in ~/.emacs.d/elpa/cider-20260414.1619/cider-docstring.el
(defcustom cider-docstring-max-lines 20
  "The maximum number of docstring lines that will be rendered in a UI widget (or the echo area).

Note that `cider-docstring' will trim thing smartly, for Java doc comments:
* First, the whole doc comment will be attempted to be rendered.
* If that exceeds `cider-docstring-max-lines',
  we will use only the first sentence and the block tags
  (that is, the params/throws/returns info).
* If that exceeds `cider-docstring-max-lines', we will use only the block tags.
* If that exceeds `cider-docstring-max-lines', we will use only the first sentence."
  :type 'integer
  :group 'cider
  :package-version '(cider . "1.8.0"))