diff options
| author | Michael Witten | 2012-07-04 22:52:00 -0400 |
|---|---|---|
| committer | Stefan Monnier | 2012-07-04 22:52:00 -0400 |
| commit | 47187200768305401540094d47531c8b066bff19 (patch) | |
| tree | f8ff4859f0b8979b66dd16fc22d2aa45606ce505 | |
| parent | 4e71fd8903e237cd2b45797bb1315f2699e1569e (diff) | |
| download | emacs-47187200768305401540094d47531c8b066bff19.tar.gz emacs-47187200768305401540094d47531c8b066bff19.zip | |
* doc/lispref/intro.texi (Evaluation Notation, A Sample Function Description)
(A Sample Variable Description, Version Info): Copy edits.
Fixes: debbugs:11862
| -rw-r--r-- | doc/lispref/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/lispref/intro.texi | 36 |
2 files changed, 25 insertions, 16 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 180e2aae596..2e70ccc026a 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2012-07-05 Michael Witten <mfwitten@gmail.com> (tiny change) | ||
| 2 | |||
| 3 | * intro.texi (Evaluation Notation, A Sample Function Description) | ||
| 4 | (A Sample Variable Description, Version Info): Copy edits (bug#11862). | ||
| 5 | |||
| 1 | 2012-06-27 Chong Yidong <cyd@gnu.org> | 6 | 2012-06-27 Chong Yidong <cyd@gnu.org> |
| 2 | 7 | ||
| 3 | * processes.texi (Asynchronous Processes, Input to Processes): | 8 | * processes.texi (Asynchronous Processes, Input to Processes): |
diff --git a/doc/lispref/intro.texi b/doc/lispref/intro.texi index 841cfacb8c8..da393751f6f 100644 --- a/doc/lispref/intro.texi +++ b/doc/lispref/intro.texi | |||
| @@ -235,7 +235,7 @@ evaluation of the expanded form. | |||
| 235 | @result{} c | 235 | @result{} c |
| 236 | @end example | 236 | @end example |
| 237 | 237 | ||
| 238 | Sometimes to help describe one form we show another form that | 238 | Sometimes to help describe one form, we show another form that |
| 239 | produces identical results. The exact equivalence of two forms is | 239 | produces identical results. The exact equivalence of two forms is |
| 240 | indicated with @samp{@equiv{}}. | 240 | indicated with @samp{@equiv{}}. |
| 241 | 241 | ||
| @@ -350,8 +350,8 @@ arguments default to @code{nil}). Do not write @code{&optional} when | |||
| 350 | you call the function. | 350 | you call the function. |
| 351 | 351 | ||
| 352 | The keyword @code{&rest} (which must be followed by a single | 352 | The keyword @code{&rest} (which must be followed by a single |
| 353 | argument name) indicates that any number of arguments can follow. The | 353 | argument name) indicates that any number of arguments may follow. The |
| 354 | single argument name following @code{&rest} will receive, as its | 354 | single argument name following @code{&rest} receives, as its |
| 355 | value, a list of all the remaining arguments passed to the function. | 355 | value, a list of all the remaining arguments passed to the function. |
| 356 | Do not write @code{&rest} when you call the function. | 356 | Do not write @code{&rest} when you call the function. |
| 357 | 357 | ||
| @@ -380,17 +380,18 @@ More generally, | |||
| 380 | @end defun | 380 | @end defun |
| 381 | 381 | ||
| 382 | Any argument whose name contains the name of a type (e.g., | 382 | Any argument whose name contains the name of a type (e.g., |
| 383 | @var{integer}, @var{integer1} or @var{buffer}) is expected to be of that | 383 | @var{integer}, @var{integer1} or @var{buffer}) is expected to be bound |
| 384 | type. A plural of a type (such as @var{buffers}) often means a list of | 384 | to an object of that type. A plural of a type (such as @var{buffers}) |
| 385 | objects of that type. Arguments named @var{object} may be of any type. | 385 | often means a list of objects of that type. An argument named with the |
| 386 | (@xref{Lisp Data Types}, for a list of Emacs object types.) Arguments | 386 | type @var{object} may be bound to an object of any type. |
| 387 | with other sorts of names (e.g., @var{new-file}) are discussed | 387 | (@xref{Lisp Data Types} for a list of Emacs object types.) An argument |
| 388 | with some other sort of name (e.g., @var{new-file}) is discussed | ||
| 388 | specifically in the description of the function. In some sections, | 389 | specifically in the description of the function. In some sections, |
| 389 | features common to the arguments of several functions are described at | 390 | features common to the arguments of several functions are described at |
| 390 | the beginning. | 391 | the beginning. |
| 391 | 392 | ||
| 392 | @xref{Lambda Expressions}, for a more complete description of optional | 393 | @xref{Lambda Expressions} for a more complete description of arguments |
| 393 | and rest arguments. | 394 | modified by @code{&optional} and @code{&rest}. |
| 394 | 395 | ||
| 395 | Command, macro, and special form descriptions have the same format, | 396 | Command, macro, and special form descriptions have the same format, |
| 396 | but the word `Function' is replaced by `Command', `Macro', or `Special | 397 | but the word `Function' is replaced by `Command', `Macro', or `Special |
| @@ -445,11 +446,14 @@ from @var{body}, which includes all remaining elements of the form. | |||
| 445 | @cindex variable descriptions | 446 | @cindex variable descriptions |
| 446 | @cindex option descriptions | 447 | @cindex option descriptions |
| 447 | 448 | ||
| 448 | A @dfn{variable} is a name that can hold a value. Although nearly | 449 | A @dfn{variable} is a name that can be bound to an object; binding |
| 449 | all variables can be set by the user, certain variables exist | 450 | is frequently referred to as `setting', and the object to which |
| 450 | specifically so that users can change them; these are called @dfn{user | 451 | a variable is `set' is often called a `value' that the variable |
| 451 | options}. Ordinary variables and user options are described using a | 452 | `holds'. Although nearly all variables can be set by the user, |
| 452 | format like that for functions except that there are no arguments. | 453 | certain variables exist specifically so that users can change them; |
| 454 | these are called @dfn{user options}. Ordinary variables and user | ||
| 455 | options are described using a format like that for functions, except | ||
| 456 | that there are no arguments. | ||
| 453 | 457 | ||
| 454 | Here is a description of the imaginary @code{electric-future-map} | 458 | Here is a description of the imaginary @code{electric-future-map} |
| 455 | variable.@refill | 459 | variable.@refill |
| @@ -504,7 +508,7 @@ emacs-build-time | |||
| 504 | The value of this variable is the version of Emacs being run. It is a | 508 | The value of this variable is the version of Emacs being run. It is a |
| 505 | string such as @code{"23.1.1"}. The last number in this string is not | 509 | string such as @code{"23.1.1"}. The last number in this string is not |
| 506 | really part of the Emacs release version number; it is incremented | 510 | really part of the Emacs release version number; it is incremented |
| 507 | each time you build Emacs in any given directory. A value with four | 511 | each time Emacs is built in any given directory. A value with four |
| 508 | numeric components, such as @code{"22.0.91.1"}, indicates an | 512 | numeric components, such as @code{"22.0.91.1"}, indicates an |
| 509 | unreleased test version. | 513 | unreleased test version. |
| 510 | @end defvar | 514 | @end defvar |