summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/cl-seq.el
diff options
context:
space:
mode:
authorBasil L. Contovounesios <contovob@tcd.ie>2019-10-07 17:54:18 +0100
committerBasil L. Contovounesios <contovob@tcd.ie>2019-10-07 17:54:18 +0100
commitbb596474207632ac5cfd139baad000c5470f6dae (patch)
treed2d21a50869403d6be6b346ca07a31577011fb81 /lisp/emacs-lisp/cl-seq.el
parent6fe58ff08865c4fd1ffaf3b01e4f1bbaa1c98ed3 (diff)
downloademacs-bb596474207632ac5cfd139baad000c5470f6dae.tar.gz
emacs-bb596474207632ac5cfd139baad000c5470f6dae.tar.bz2
emacs-bb596474207632ac5cfd139baad000c5470f6dae.zip
Improve recent doc fix for cl-reduce
* lisp/emacs-lisp/cl-seq.el: (cl-reduce): Clarify treatment of :INITIAL-VALUE when :FROM-END is non-nil. Improve wording when SEQ is empty and :INITIAL-VALUE is unspecified (bug#37400). Describe behavior when SEQ comprises a single element.
Diffstat (limited to 'lisp/emacs-lisp/cl-seq.el')
-rw-r--r--lisp/emacs-lisp/cl-seq.el18
1 files changed, 10 insertions, 8 deletions
diff --git a/lisp/emacs-lisp/cl-seq.el b/lisp/emacs-lisp/cl-seq.el
index 520d450481f..df3fbe89e95 100644
--- a/lisp/emacs-lisp/cl-seq.el
+++ b/lisp/emacs-lisp/cl-seq.el
@@ -129,14 +129,16 @@ second element of SEQ, then calling FUNCTION with that result and
the third element of SEQ, then with that result and the fourth
element of SEQ, etc.
-If :INITIAL-VALUE is specified, it is added to the front of SEQ.
-If SEQ is empty, return :INITIAL-VALUE and FUNCTION is not
-called.
-
-If SEQ is empty and no :INITIAL-VALUE is given, then the function
-is called with zero arguments, and reduce returns whatever
-function does. This is the only case where the function is called
-with other than two arguments.
+If :INITIAL-VALUE is specified, it is logically added to the
+front of SEQ (or the back if :FROM-END is non-nil). If SEQ is
+empty, return :INITIAL-VALUE and FUNCTION is not called.
+
+If SEQ is empty and no :INITIAL-VALUE is specified, then return
+the result of calling FUNCTION with zero arguments. This is the
+only case where FUNCTION is called with fewer than two arguments.
+
+If SEQ contains exactly one element and no :INITIAL-VALUE is
+specified, then return that element and FUNCTION is not called.
\n(fn FUNCTION SEQ [KEYWORD VALUE]...)"
(cl--parsing-keywords (:from-end (:start 0) :end :initial-value :key) ()