diff options
| author | Paul Eggert | 2018-12-17 09:55:06 -0800 |
|---|---|---|
| committer | Paul Eggert | 2018-12-17 10:26:15 -0800 |
| commit | a5995a326d1dad9bccf1ad7eb96e4e8146f6dcbe (patch) | |
| tree | 12d89cba78255f1181cca879ffd36fa188bab774 /doc/lispref | |
| parent | 8664ba18c7c56bc463f69dd5b131b4071612d567 (diff) | |
| download | emacs-a5995a326d1dad9bccf1ad7eb96e4e8146f6dcbe.tar.gz emacs-a5995a326d1dad9bccf1ad7eb96e4e8146f6dcbe.zip | |
Improve flatten-tree documentation
* doc/lispref/lists.texi (Building Lists):
* lisp/subr.el (flatten-tree):
Don’t imply that flatten-tree modifies its argument.
Clarify wording.
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/lists.texi | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/lispref/lists.texi b/doc/lispref/lists.texi index 31cc3190854..0a1d5b5dc33 100644 --- a/doc/lispref/lists.texi +++ b/doc/lispref/lists.texi | |||
| @@ -668,10 +668,10 @@ their elements). | |||
| 668 | @end defun | 668 | @end defun |
| 669 | 669 | ||
| 670 | @defun flatten-tree tree | 670 | @defun flatten-tree tree |
| 671 | Take @var{tree} and "flatten" it. | 671 | This function returns a ``flattened'' copy of @var{tree}, that is, |
| 672 | This always returns a list containing all the terminal nodes, or | 672 | a list containing all the non-@code{nil} terminal nodes, or leaves, of |
| 673 | leaves, of @var{tree}. Dotted pairs are flattened as well, and nil | 673 | the tree of cons cells rooted at @var{tree}. Leaves in the returned |
| 674 | elements are removed. | 674 | list are in the same order as in @var{tree}. |
| 675 | @end defun | 675 | @end defun |
| 676 | 676 | ||
| 677 | @example | 677 | @example |
| @@ -680,7 +680,7 @@ elements are removed. | |||
| 680 | @end example | 680 | @end example |
| 681 | 681 | ||
| 682 | @defun number-sequence from &optional to separation | 682 | @defun number-sequence from &optional to separation |
| 683 | This returns a list of numbers starting with @var{from} and | 683 | This function returns a list of numbers starting with @var{from} and |
| 684 | incrementing by @var{separation}, and ending at or just before | 684 | incrementing by @var{separation}, and ending at or just before |
| 685 | @var{to}. @var{separation} can be positive or negative and defaults | 685 | @var{to}. @var{separation} can be positive or negative and defaults |
| 686 | to 1. If @var{to} is @code{nil} or numerically equal to @var{from}, | 686 | to 1. If @var{to} is @code{nil} or numerically equal to @var{from}, |