emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

emacs-27 6956867: Improve documentation of function argument lists


From: Eli Zaretskii
Subject: emacs-27 6956867: Improve documentation of function argument lists
Date: Thu, 13 Aug 2020 10:09:33 -0400 (EDT)

branch: emacs-27
commit 69568674b3bb5b5f65f2c1342aded205a00f696a
Author: Eli Zaretskii <eliz@gnu.org>
Commit: Eli Zaretskii <eliz@gnu.org>

    Improve documentation of function argument lists
    
    * doc/lispref/functions.texi (Lambda Components)
    (Defining Functions): Add a cross-reference to "Argument List".
    (Argument List): Improve the section name.  (Bug#42750)
---
 doc/lispref/functions.texi | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
index bc8ec0e..2898cb4 100644
--- a/doc/lispref/functions.texi
+++ b/doc/lispref/functions.texi
@@ -267,7 +267,8 @@ reason functions are defined to start with @code{lambda} is 
so that
 other lists, intended for other uses, will not accidentally be valid as
 functions.
 
-  The second element is a list of symbols---the argument variable names.
+  The second element is a list of symbols---the argument variable
+names (@pxref{Argument List}).
 This is called the @dfn{lambda list}.  When a Lisp function is called,
 the argument values are matched up against the variables in the lambda
 list, which are given local bindings with the values provided.
@@ -342,7 +343,7 @@ stored as symbol function definitions to produce named 
functions
 (@pxref{Function Names}).
 
 @node Argument List
-@subsection Other Features of Argument Lists
+@subsection Features of Argument Lists
 @kindex wrong-number-of-arguments
 @cindex argument binding
 @cindex binding arguments
@@ -583,8 +584,8 @@ a function.
 @defmac defun name args [doc] [declare] [interactive] body@dots{}
 @code{defun} is the usual way to define new Lisp functions.  It
 defines the symbol @var{name} as a function with argument list
-@var{args} and body forms given by @var{body}.  Neither @var{name} nor
-@var{args} should be quoted.
+@var{args} (@pxref{Argument List}) and body forms given by @var{body}.
+Neither @var{name} nor @var{args} should be quoted.
 
 @var{doc}, if present, should be a string specifying the function's
 documentation string (@pxref{Function Documentation}).  @var{declare},



reply via email to

[Prev in Thread] Current Thread [Next in Thread]