From 0a6928035fb4cc5bc8f20fc774463cd8a83dfbd4 Mon Sep 17 00:00:00 2001 From: Dave Love Date: Mon, 6 Oct 2003 16:40:10 +0000 Subject: [PATCH] usage: in doc strings. Correct side-effect function remark. --- lispref/internals.texi | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/lispref/internals.texi b/lispref/internals.texi index 1810d0b9b9e..721e1a5a7d6 100644 --- a/lispref/internals.texi +++ b/lispref/internals.texi @@ -563,6 +563,8 @@ If the last line of the documentation string begins with the keyword @samp{usage:}, the rest of the line is treated as the argument list for documentation purposes. This way, you can use different argument names in the documentation string from the ones used in the C code. +@samp{usage:} is required if the function has an unlimited number of +arguments. All the usual rules for documentation strings in Lisp code (@pxref{Documentation Tips}) apply to C code documentation strings @@ -746,10 +748,10 @@ number of arguments. They work by calling @code{Ffuncall}. @file{lisp.h} contains the definitions for some important macros and functions. - If you define a function which is side-effect free, update the code in -@file{byte-opt.el} which binds @code{side-effect-free-fns} and -@code{side-effect-and-error-free-fns} to include it. This will help the -optimizer. + If you define a function which is side-effect free, update the code +in @file{byte-opt.el} which binds @code{side-effect-free-fns} and +@code{side-effect-and-error-free-fns} so that the compiler optimizer +knows about it. @node Object Internals @appendixsec Object Internals -- 2.39.2