summaryrefslogtreecommitdiff
path: root/doc/misc/cl.texi
diff options
context:
space:
mode:
authorStefan Kangas <stefan@marxist.se>2021-10-23 19:20:31 +0200
committerStefan Kangas <stefan@marxist.se>2021-10-23 19:20:56 +0200
commit43914ab01fc83466c701de7b350dd957a21c1c6c (patch)
treeae5731b88d78d8d9456238bfd2f95e488b9438d7 /doc/misc/cl.texi
parentef37a86cacab221aa26fc8c2f746626e6e81ebc6 (diff)
downloademacs-43914ab01fc83466c701de7b350dd957a21c1c6c.tar.gz
emacs-43914ab01fc83466c701de7b350dd957a21c1c6c.tar.bz2
emacs-43914ab01fc83466c701de7b350dd957a21c1c6c.zip
Improve documentation of cl-reduce
* doc/misc/cl.texi (Mapping over Sequences): Change the explanation of 'cl-reduce' so you don't need to have a major in mathematics to understand it. (Bug#24014)
Diffstat (limited to 'doc/misc/cl.texi')
-rw-r--r--doc/misc/cl.texi10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi
index a6c3c32c0eb..0ec02495d5e 100644
--- a/doc/misc/cl.texi
+++ b/doc/misc/cl.texi
@@ -3364,9 +3364,13 @@ true for all elements.
@end defun
@defun cl-reduce function seq @t{&key :from-end :start :end :initial-value :key}
-This function combines the elements of @var{seq} using an associative
-binary operation. Suppose @var{function} is @code{*} and @var{seq} is
-the list @code{(2 3 4 5)}. The first two elements of the list are
+This function returns the result of calling @var{function} on the
+first and second element of @var{seq}, then calling @var{function}
+with that result and the third element of @var{seq}, then with that
+result and the third element of @var{seq}, etc.
+
+Here is an example. Suppose @var{function} is @code{*} and @var{seq}
+is the list @code{(2 3 4 5)}. The first two elements of the list are
combined with @code{(* 2 3) = 6}; this is combined with the next
element, @code{(* 6 4) = 24}, and that is combined with the final
element: @code{(* 24 5) = 120}. Note that the @code{*} function happens