emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/setup d1a55e7 07/24: Simplify setup docstring


From: Stefan Monnier
Subject: [elpa] externals/setup d1a55e7 07/24: Simplify setup docstring
Date: Thu, 25 Mar 2021 13:42:35 -0400 (EDT)

branch: externals/setup
commit d1a55e753edd5a659cc29f9c50a50c7ed5357d43
Author: Philip K <philipk@posteo.net>
Commit: Philip K <philipk@posteo.net>

    Simplify setup docstring
---
 setup.el | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)

diff --git a/setup.el b/setup.el
index 4de72e9..94e867a 100644
--- a/setup.el
+++ b/setup.el
@@ -80,9 +80,11 @@ Do not modify this variable by hand.  Instead use
 (defun setup-make-docstring ()
   "Return a docstring for `setup'."
   (with-temp-buffer
-    (insert (documentation (symbol-function 'setup) 'raw))
-    (dolist (sym (sort (mapcar #'car setup-macros)
-                       #'string-lessp))
+    (insert (documentation (symbol-function 'setup) 'raw)
+            "\n\n"
+            "Within BODY, `setup' provides these local macros:")
+    (dolist (sym (sort (mapcar #'car setup-macros) #'string-lessp))
+      (newline 2)
       (let ((sig (mapcar
                   (lambda (arg)
                     (if (string-match "\\`&" (symbol-name arg))
@@ -91,17 +93,14 @@ Do not modify this variable by hand.  Instead use
                   (get sym 'setup-signature))))
         (insert (format " - %s\n\n" (cons sym sig))
                 (or (get sym 'setup-documentation)
-                    "No documentation.")
-                "\n\n")))
+                    "No documentation."))))
     (buffer-string)))
 
 ;;;###autoload
 (defmacro setup (name &rest body)
   "Configure feature or subsystem NAME.
 BODY may contain special forms defined by `setup-define', but
-will otherwise just be evaluated as is.
-
-The following local macros are defined in a `setup' body:\n\n"
+will otherwise just be evaluated as is."
   (declare (debug (&rest &or [symbolp sexp] form))
            (indent defun))
   (when (consp name)



reply via email to

[Prev in Thread] Current Thread [Next in Thread]