Function: internal--format-docstring-line

internal--format-docstring-line is a byte-compiled function defined in subr.el.gz.

Signature

(internal--format-docstring-line STRING &rest OBJECTS)

Documentation

Format a single line from a documentation string out of STRING and OBJECTS.

Signal an error if STRING contains a newline. This is intended for internal use only. Avoid using this for the first line of a docstring; the first line should be a complete sentence (see Info node (elisp) Documentation Tips).

Source Code

;; Defined in /usr/src/emacs/lisp/subr.el.gz
(defun internal--format-docstring-line (string &rest objects)
  "Format a single line from a documentation string out of STRING and OBJECTS.
Signal an error if STRING contains a newline.
This is intended for internal use only.  Avoid using this for the
first line of a docstring; the first line should be a complete
sentence (see Info node `(elisp) Documentation Tips')."
  (when (string-match "\n" string)
    (error "Unable to fill string containing newline: %S" string))
  (internal--fill-string-single-line (apply #'format string objects)))