From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Sat, 4 Jun 2022 11:57:08 +0000 (+0200)
Subject: Improve the raise-sexp doc string
X-Git-Tag: emacs-29.0.90~1910^2~237
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b3dc23dd60896423f1a7ccbe5ab747f54599ea24;p=emacs.git

Improve the raise-sexp doc string

* lisp/emacs-lisp/lisp.el (raise-sexp): Try to explain what the
command does (bug#55788).
---

diff --git a/lisp/emacs-lisp/lisp.el b/lisp/emacs-lisp/lisp.el
index ffca0dcf4f5..9d9ae41f301 100644
--- a/lisp/emacs-lisp/lisp.el
+++ b/lisp/emacs-lisp/lisp.el
@@ -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))