procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve doc strings of a recent commit

Browse source 
* 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.
This commit is contained in:
Eli Zaretskii 2021-09-18 14:56:55 +03:00
parent 031e1c28f9
commit 83e3d8d879
4 changed files with 9 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
lisp/emacs-lisp/autoload.el
View file

@ -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