From 13a105af210280e47773abd7f985f1985ea2cda6 Mon Sep 17 00:00:00 2001 From: "Richard M. Stallman" Date: Tue, 22 Jul 2003 15:22:50 +0000 Subject: [PATCH] (Function Documentation): Explain how to show calling convention explicitly in the doc string. --- lispref/functions.texi | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/lispref/functions.texi b/lispref/functions.texi index 9ffb6561b23..e6f50bf4168 100644 --- a/lispref/functions.texi +++ b/lispref/functions.texi @@ -411,7 +411,7 @@ of one or two complete sentences that summarize the function's purpose. 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 +@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. @@ -423,6 +423,19 @@ 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 @cindex function definition -- 2.39.2