]> git.eshelyaron.com Git - emacs.git/commitdiff
; Improve documentation of a recent addition
authorEli Zaretskii <eliz@gnu.org>
Fri, 11 Aug 2023 11:52:12 +0000 (14:52 +0300)
committerEli Zaretskii <eliz@gnu.org>
Fri, 11 Aug 2023 11:52:12 +0000 (14:52 +0300)
* lisp/simple.el (kill-ring-deindent-buffer-substring-function):
Doc fix.

lisp/simple.el

index 604ab0541bfef58d1bdb53e3dfe75affe0c50d25..561b1f7fbebe19021ce38aa666cf4548c5ad2985 100644 (file)
@@ -11146,11 +11146,12 @@ seconds."
 ;; killed text to remove leading indentation.
 
 (defun kill-ring-deindent-buffer-substring-function (beg end delete)
-  "Save the text within BEG and END to the kill ring.
-Maybe delete it if DELETE is non-nil.
+  "Save the text within BEG and END to kill-ring, decreasing indentation.
+Delete the saved text if DELETE is non-nil.
 
-Before saving the text, indent it leftwards by the number of
-columns at BEG."
+In the saved copy of the text, remove some of the indentation, such
+that the buffer position at BEG will be at column zero when the text
+is yanked."
   (let ((a beg)
         (b end))
     (setq beg (min a b)