From 83e3d8d8795c8162490a83f5d1a9d14763b8694f Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sat, 18 Sep 2021 14:56:55 +0300 Subject: Improve doc strings of a recent commit * lisp/emacs-lisp/generator.el (iter-defun): * lisp/emacs-lisp/comp.el (comp-clean-up-stale-eln): * lisp/emacs-lisp/bytecomp.el (byte-compile-lapcode): * lisp/emacs-lisp/autoload.el (autoload-insert-section-header): Include description of arguments in the doc string's first line. --- lisp/emacs-lisp/autoload.el | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'lisp/emacs-lisp/autoload.el') diff --git a/lisp/emacs-lisp/autoload.el b/lisp/emacs-lisp/autoload.el index 38512e04e75..f620cdbb335 100644 --- a/lisp/emacs-lisp/autoload.el +++ b/lisp/emacs-lisp/autoload.el @@ -432,8 +432,10 @@ FILE's name." file) (defun autoload-insert-section-header (outbuf autoloads load-name file time) - "Insert the section-header line. -This lists the file name and which functions are in it, etc." + "Insert into buffer OUTBUF the section-header line for FILE. +The header line lists the file name, its \"load name\", its autoloads, +and the time the FILE was last updated (the time is inserted only +if `autoload-timestamps' is non-nil, otherwise a fixed fake time is inserted)." ;; (cl-assert ;Make sure we don't insert it in the middle of another section. ;; (save-excursion ;; (or (not (re-search-backward -- cgit v1.2.1