[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to emacs/lispref/functions.texi
From: |
Richard M. Stallman |
Subject: |
[Emacs-diffs] Changes to emacs/lispref/functions.texi |
Date: |
Tue, 22 Jul 2003 11:22:50 -0400 |
Index: emacs/lispref/functions.texi
diff -c emacs/lispref/functions.texi:1.22 emacs/lispref/functions.texi:1.23
*** emacs/lispref/functions.texi:1.22 Mon Jun 30 06:40:27 2003
--- emacs/lispref/functions.texi Tue Jul 22 11:22:50 2003
***************
*** 411,417 ****
but since these spaces come before the starting double-quote, they are not
part of
the string. Some people make a practice of indenting any additional
lines of the string so that the text lines up in the program source.
! @emph{This is a mistake.} The indentation of the following lines is
inside the string; what looks nice in the source code will look ugly
when displayed by the help commands.
--- 411,417 ----
but since these spaces come before the starting double-quote, they are not
part of
the string. Some people make a practice of indenting any additional
lines of the string so that the text lines up in the program source.
! @emph{That is a mistake.} The indentation of the following lines is
inside the string; what looks nice in the source code will look ugly
when displayed by the help commands.
***************
*** 422,427 ****
--- 422,440 ----
practice, there is no confusion between the first form of the body and the
documentation string; if the only body form is a string then it serves both
as the return value and as the documentation.
+
+ The last line of the documentation string can specify calling
+ conventions different from the actual function arguments. Write
+ text like this:
+
+ @example
+ (fn @var{arglist})
+ @end example
+
+ @noindent
+ following a blank line, with no newline following it inside the
+ documentation string. This feature is particularly useful for
+ macro definitions.
@node Function Names
@section Naming a Function
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] Changes to emacs/lispref/functions.texi,
Richard M. Stallman <=