]> git.eshelyaron.com Git - emacs.git/commitdiff
; Fix doc string of 'string-fill'
authorEli Zaretskii <eliz@gnu.org>
Sat, 6 Jul 2024 08:28:39 +0000 (11:28 +0300)
committerEshel Yaron <me@eshelyaron.com>
Sun, 7 Jul 2024 13:16:55 +0000 (15:16 +0200)
* lisp/emacs-lisp/subr-x.el (string-fill): Rename LENGTH to WIDTH
and update the doc string accordingly.  (Bug#71856)

(cherry picked from commit a3e57a29becdc028d5a5059c35b5f7be7c1510e4)

lisp/emacs-lisp/subr-x.el

index e62a08b7a8bb0a5e681e3ecc95638d5df3ed9be7..e725c490abacc661cec1813a9bc3d1e7a61a009a 100644 (file)
@@ -159,16 +159,16 @@ removed."
                  blank blank)))
 
 ;;;###autoload
-(defun string-fill (string length)
-  "Try to word-wrap STRING so that no lines are longer than LENGTH.
-Wrapping is done where there is whitespace.  If there are
-individual words in STRING that are longer than LENGTH, the
-result will have lines that are longer than LENGTH."
+(defun string-fill (string width)
+  "Try to word-wrap STRING so that it displays with lines no wider than WIDTH.
+STRING is wrapped where there is whitespace in it.  If there are
+individual words in STRING that are wider than WIDTH, the result
+will have lines that are wider than WIDTH."
   (declare (important-return-value t))
   (with-temp-buffer
     (insert string)
     (goto-char (point-min))
-    (let ((fill-column length)
+    (let ((fill-column width)
           (adaptive-fill-mode nil))
       (fill-region (point-min) (point-max)))
     (buffer-string)))