]> git.eshelyaron.com Git - emacs.git/commitdiff
; * lisp/emacs-lisp/subr-x.el (string-limit): Clarify doc string.
authorEli Zaretskii <eliz@gnu.org>
Tue, 5 Jul 2022 16:45:35 +0000 (19:45 +0300)
committerEli Zaretskii <eliz@gnu.org>
Tue, 5 Jul 2022 16:45:35 +0000 (19:45 +0300)
lisp/emacs-lisp/subr-x.el

index 39697a8e725af9760a5aee0cabc0d042c785b6aa..5159e8784a597356548c39b14f7160217e87172b 100644 (file)
@@ -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