mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00
Code Issues Projects Releases Wiki Activity

Improve the string-limit doc string

Browse source 
* lisp/emacs-lisp/subr-x.el (string-limit): Mention
truncate-string-to-width in the doc string.
This commit is contained in:
Lars Ingebrigtsen 2020-12-23 07:59:24 +01:00
parent 22c1f00d99
commit 5c86a53296
2 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
lisp/emacs-lisp/shortdoc.el
View file

@ -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|" "|")

6
lisp/emacs-lisp/subr-x.el
View file

@ -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