Function: cider-docstring--format

cider-docstring--format is a byte-compiled function defined in cider-docstring.el.

Signature

(cider-docstring--format STRING)

Documentation

Return a nicely formatted STRING to be displayed to the user.

We need to format the docstring before displaying it to the user because it is obtained from the source code. For example, this means that it usually has two spaces before each line used for indentation
(see https://guide.clojure.style/#docstring-indentation). While displaying
the docstring to the user, we usually want to control indentation and other aspects of the presentation, so we format it before displaying.

Source Code

;; Defined in ~/.emacs.d/elpa/cider-20260414.1619/cider-docstring.el
(defun cider-docstring--format (string)
  "Return a nicely formatted STRING to be displayed to the user.

We need to format the docstring before displaying it to the user
because it is obtained from the source code.  For example, this means
that it usually has two spaces before each line used for indentation
\(see https://guide.clojure.style/#docstring-indentation).  While displaying
the docstring to the user, we usually want to control indentation and
other aspects of the presentation, so we format it before displaying."
  (when string
    (replace-regexp-in-string "\n  " "\n" string)))