From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Wed, 23 Dec 2020 06:59:24 +0000 (+0100)
Subject: Improve the string-limit doc string
X-Git-Tag: emacs-28.0.90~4604
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=5c86a5329664cd5fd3b81fe991c8d7dc18815e07;p=emacs.git

Improve the string-limit doc string

* lisp/emacs-lisp/subr-x.el (string-limit): Mention
truncate-string-to-width in the doc string.
---

diff --git a/lisp/emacs-lisp/shortdoc.el b/lisp/emacs-lisp/shortdoc.el
index e9e1be1d550..0067495fea0 100644
--- a/lisp/emacs-lisp/shortdoc.el
+++ b/lisp/emacs-lisp/shortdoc.el
@@ -147,6 +147,9 @@ There can be any number of :example/:result elements."
    :eval (string-limit "foobar" 3)
    :eval (string-limit "foobar" 3 t)
    :eval (string-limit "foobar" 10))
+  (truncate-string-to-width
+   :eval (truncate-string-to-width "foobar" 3)
+   :eval (truncate-string-to-width "你好bar" 5))
   (split-string
    :eval (split-string "foo bar")
    :eval (split-string "|foo|bar|" "|")
diff --git a/lisp/emacs-lisp/subr-x.el b/lisp/emacs-lisp/subr-x.el
index 8a9424cbb3d..7e17a3464e6 100644
--- a/lisp/emacs-lisp/subr-x.el
+++ b/lisp/emacs-lisp/subr-x.el
@@ -293,7 +293,11 @@ is returned unchanged.
 
 If STRING is longer than LENGTH, return a substring consisting of
 the first LENGTH characters of STRING.  If END is non-nil, return
-the last LENGTH characters instead."
+the last LENGTH characters instead.
+
+When shortening strings for display purposes,
+`truncate-string-to-width' is almost always a better alternative
+than this function."
   (unless (natnump length)
     (signal 'wrong-type-argument (list 'natnump length)))
   (cond