mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-05 22:20:24 -08:00
Code Issues Projects Releases Wiki Activity

Adjust documentation for make-docfile

Browse source 
* doc/lispref/loading.texi (Autoload): We're no longer using
make-docfile for loaddefs.el, but we're retaining the format.
Adjust the documentation.
* lisp/loadup.el: Adjust commentary.
This commit is contained in:
Lars Ingebrigtsen 2022-08-04 08:05:16 +02:00
parent caa88cfebe
commit c17f1a2e89
2 changed files with 10 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

15
doc/lispref/loading.texi
View file

@ -698,14 +698,13 @@ Switch to *doctor* buffer and start giving psychotherapy.
@noindent
@cindex @code{fn} in function's documentation string
The backslash and newline immediately following the double-quote are a
convention used only in the preloaded uncompiled Lisp files such as
@file{loaddefs.el}; they tell @code{make-docfile} to put the
documentation string in the @file{etc/DOC} file. @xref{Building Emacs}.
See also the commentary in @file{lib-src/make-docfile.c}. @samp{(fn)}
in the usage part of the documentation string is replaced with the
function's name when the various help functions (@pxref{Help
Functions}) display it.
While the @file{loaddefs.el} isn't for editing, we try to keep it
somewhat readable for people. For instance, control characters in
@code{defvar} values are escaped, and we insert a backslash and
newline immediately following the double-quote of the doc string to
keep the line length down. @samp{(fn)} in the usage part of the
documentation string is replaced with the function's name when the
various help functions (@pxref{Help Functions}) display it.
If you write a function definition with an unusual macro that is not
one of the known and recognized function definition methods, use of an