]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve the raise-sexp doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Sat, 4 Jun 2022 11:57:08 +0000 (13:57 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sat, 4 Jun 2022 11:57:08 +0000 (13:57 +0200)
* lisp/emacs-lisp/lisp.el (raise-sexp): Try to explain what the
command does (bug#55788).

lisp/emacs-lisp/lisp.el

index ffca0dcf4f53581d2ac2ded4ac7afb3a9a7e50c9..9d9ae41f30179359520f910df2573b48d401d9e5 100644 (file)
@@ -858,7 +858,22 @@ The option `delete-pair-blink-delay' can disable blinking."
       (delete-char 1))))
 
 (defun raise-sexp (&optional arg)
-  "Raise ARG sexps higher up the tree."
+  "Raise ARG sexps higher up the tree.
+This means that the ARGth enclosing form will be deleted and
+replaced with the form that follows point.
+
+For instance, if you have:
+
+  (let ((foo 2))
+    (progn
+      (setq foo 3)
+      (zot)
+      (+ foo 2)))
+
+and point is before (zot), `M-x raise-sexp' will give you
+
+  (let ((foo 2))
+    (zot))"
   (interactive "p")
   (let ((s (if (and transient-mark-mode mark-active)
                (buffer-substring (region-beginning) (region-end))