# HG changeset patch # User Eli Zaretskii # Date 1122114145 0 # Node ID 68b56bb47e559d8a68c236d27e5f1b25b4a0bf6a # Parent 4d62b8f93b0aa8b8b1229d19726d7479999b2e3f (Autoload): Make the `doctor' example be consistent with what's in current loaddefs.el. Describe the "fn" magic in the usage portion of the doc string. diff -r 4d62b8f93b0a -r 68b56bb47e55 lispref/loading.texi --- a/lispref/loading.texi Sat Jul 23 07:50:27 2005 +0000 +++ b/lispref/loading.texi Sat Jul 23 10:22:25 2005 +0000 @@ -481,17 +481,22 @@ Here's what that produces in @file{loaddefs.el}: @smallexample -(autoload 'doctor "doctor" "\ -Switch to *doctor* buffer and start giving psychotherapy." - t) +(autoload (quote doctor) "doctor" "\ +Switch to *doctor* buffer and start giving psychotherapy. + +\(fn)" t nil) @end smallexample @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}. +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. 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