Variable: lisp-fill-paragraphs-as-doc-string

lisp-fill-paragraphs-as-doc-string is a variable defined in lisp-mode.el.gz.

Value

t

Documentation

Whether lisp-fill-paragraph should fill strings as Elisp doc strings.

The default behavior of lisp-fill-paragraph is tuned for filling Emacs Lisp doc strings, with their special treatment for the first line. Specifically, strings are filled in a narrowed context to avoid filling surrounding code, which means any leading indent is disregarded, which can cause the filled string to extend passed the configured fill-column variable value. If you would rather fill the string in its original context, disregarding the special conventions of Elisp doc strings, and want to ensure the fill-column value is more strictly respected, set this variable to nil. Doing so makes lisp-fill-paragraph behave as it used to in Emacs 27 and prior versions.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/lisp-mode.el.gz
(defvar lisp-fill-paragraphs-as-doc-string t
  "Whether `lisp-fill-paragraph' should fill strings as Elisp doc strings.
The default behavior of `lisp-fill-paragraph' is tuned for filling Emacs
Lisp doc strings, with their special treatment for the first line.
Specifically, strings are filled in a narrowed context to avoid filling
surrounding code, which means any leading indent is disregarded, which
can cause the filled string to extend passed the configured
`fill-column' variable value.  If you would rather fill the string in
its original context, disregarding the special conventions of Elisp doc
strings, and want to ensure the `fill-column' value is more strictly
respected, set this variable to nil.  Doing so makes
`lisp-fill-paragraph' behave as it used to in Emacs 27 and prior
versions.")