changeset 52781:ab70a4157c5c

usage: in doc strings. Correct side-effect function remark.
author Dave Love <fx@gnu.org>
date Mon, 06 Oct 2003 16:40:10 +0000
parents 47bf5f5df3c9
children 85ff8647dab6
files lispref/internals.texi
diffstat 1 files changed, 6 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/internals.texi	Mon Oct 06 16:36:56 2003 +0000
+++ b/lispref/internals.texi	Mon Oct 06 16:40:10 2003 +0000
@@ -563,6 +563,8 @@
 @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 @@
 @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