summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/subr-x.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2022-07-05 19:45:35 +0300
committerEli Zaretskii <eliz@gnu.org>2022-07-05 19:45:35 +0300
commit99872bedf07315f642d143feaed9075a7ea20cba (patch)
tree04f03505562178828cb4515281085625d24822a2 /lisp/emacs-lisp/subr-x.el
parent23e4a30da283472a55b12ab1d120d703de435523 (diff)
downloademacs-99872bedf07315f642d143feaed9075a7ea20cba.tar.gz
; * lisp/emacs-lisp/subr-x.el (string-limit): Clarify doc string.
Diffstat (limited to 'lisp/emacs-lisp/subr-x.el')
-rw-r--r--lisp/emacs-lisp/subr-x.el9
1 files changed, 4 insertions, 5 deletions
diff --git a/lisp/emacs-lisp/subr-x.el b/lisp/emacs-lisp/subr-x.el
index 39697a8e725..5159e8784a5 100644
--- a/lisp/emacs-lisp/subr-x.el
+++ b/lisp/emacs-lisp/subr-x.el
@@ -170,11 +170,10 @@ limit the string to. The result will be a unibyte string that is
shorter than LENGTH, but will not contain \"partial\"
characters (or glyphs), even if CODING-SYSTEM encodes characters
with several bytes per character. If the coding system specifies
-things like byte order marks (aka \"BOM\") or language tags, they
-will normally be part of the calculation. This is the case, for
-instance, with `utf-16'. If this isn't desired, use a coding
-system that doesn't specify a BOM, like `utf-16le' or
-`utf-16be'.
+prefix like the byte order mark (aka \"BOM\") or a shift-in sequence,
+their bytes will be normally counted as part of LENGTH. This is
+the case, for instance, with `utf-16'. If this isn't desired, use a
+coding system that doesn't specify a BOM, like `utf-16le' or `utf-16be'.
When shortening strings for display purposes,
`truncate-string-to-width' is almost always a better alternative