[Emacs-diffs] master 1879b90: Better documentation for cl-reduce (bug#24014)

[Nicolas Petton]

branch: master
commit 1879b9055eaf5c9f3fd126c2c21450cdd8c83262
Author: Nicolas Petton <address@hidden>
Commit: Nicolas Petton <address@hidden>

    Better documentation for cl-reduce (bug#24014)
    
    * lisp/emacs-lisp/cl-seq.el (cl-reduce): Explain what reducing means.
---
 lisp/emacs-lisp/cl-seq.el |   10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/lisp/emacs-lisp/cl-seq.el b/lisp/emacs-lisp/cl-seq.el
index 21aec6c..443a147 100644
--- a/lisp/emacs-lisp/cl-seq.el
+++ b/lisp/emacs-lisp/cl-seq.el
@@ -116,6 +116,16 @@
 (defun cl-reduce (cl-func cl-seq &rest cl-keys)
   "Reduce two-argument FUNCTION across SEQ.
 \nKeywords supported:  :start :end :from-end :initial-value :key
+
+Return the result of calling FUNCTION with the first and the
+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.
+
 \n(fn FUNCTION SEQ [KEYWORD VALUE]...)"
   (cl--parsing-keywords (:from-end (:start 0) :end :initial-value :key) ()
     (or (listp cl-seq) (setq cl-seq (append cl-seq nil)))