]> git.eshelyaron.com Git - emacs.git/commitdiff
; Reflow some cl-lib docstrings
authorStefan Kangas <stefankangas@gmail.com>
Mon, 24 Feb 2025 02:45:18 +0000 (03:45 +0100)
committerEshel Yaron <me@eshelyaron.com>
Tue, 4 Mar 2025 20:49:35 +0000 (21:49 +0100)
* lisp/emacs-lisp/cl-macs.el (cl-flet, cl-labels): Reflow docstrings.

(cherry picked from commit 63adf9dcf53ac64585803fe5f9ad0acb107a9f9f)

lisp/emacs-lisp/cl-macs.el

index 631853ba92c88424240c731ebec5549251dedd4d..84896239ba3c0d791c966de3b16ef40b673d7f47 100644 (file)
@@ -2018,16 +2018,15 @@ a `let' form, except that the list of symbols can be computed at run-time."
 ;;;###autoload
 (defmacro cl-flet (bindings &rest body)
   "Make local function definitions.
-Each definition can take the form (FUNC EXP) where
-FUNC is the function name, and EXP is an expression that returns the
-function value to which it should be bound, or it can take the more common
-form (FUNC ARGLIST BODY...) which is a shorthand
-for (FUNC (lambda ARGLIST BODY)) where BODY is wrapped in
-a `cl-block' named FUNC.
 
-FUNC is defined only within FORM, not BODY, so you can't write
-recursive function definitions.  Use `cl-labels' for that.  See
-info node `(cl) Function Bindings' for details.
+Each definition can take the form (FUNC EXP) where FUNC is the function
+name, and EXP is an expression that returns the function value to which
+it should be bound, or it can take the more common form (FUNC ARGLIST
+BODY...) which is a shorthand for (FUNC (lambda ARGLIST BODY)).
+
+FUNC is defined only within FORM, not BODY, so you can't write recursive
+function definitions.  Use `cl-labels' for that.  See Info node
+`(cl) Function Bindings' for details.
 
 \(fn ((FUNC ARGLIST BODY...) ...) FORM...)"
   (declare (indent 1)
@@ -2226,16 +2225,14 @@ Like `cl-flet' but the definitions can refer to previous ones.
 ;;;###autoload
 (defmacro cl-labels (bindings &rest body)
   "Make local (recursive) function definitions.
-BINDINGS is a list of definitions of the form either (FUNC EXP)
-where EXP is a form that should return the function to bind to the
-function name FUNC, or (FUNC ARGLIST BODY...) where
-FUNC is the function name, ARGLIST its arguments, and BODY the
-forms of the function body.  BODY is wrapped in a `cl-block' named FUNC.
-FUNC is in scope in any BODY or EXP, as well as in FORM, so you can write
-recursive and mutually recursive function definitions, with the caveat
-that EXPs are evaluated in sequence and you cannot call a FUNC before its
-EXP has been evaluated.
-See info node `(cl) Function Bindings' for details.
+
+BINDINGS is a list of definitions of the form (FUNC ARGLIST BODY...)
+where FUNC is the function name, ARGLIST its arguments, and BODY the
+forms of the function body.
+
+FUNC is defined in any BODY, as well as FORM, so you can write recursive
+and mutually recursive function definitions.  See Info node
+`(cl) Function Bindings' for details.
 
 \(fn ((FUNC ARGLIST BODY...) ...) FORM...)"
   (declare (indent 1) (debug cl-flet))