procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Mention byte order marks in string-limit doc string

Browse source 
* lisp/emacs-lisp/subr-x.el (string-limit): Mention byte order
marks (bug#48324).
This commit is contained in:
Lars Ingebrigtsen 2022-07-05 13:07:56 +02:00
parent 59276ff81d
commit 8681bf1e85
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -169,7 +169,12 @@ limiting, and LENGTH is interpreted as the number of bytes to
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.
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'.
When shortening strings for display purposes,
`truncate-string-to-width' is almost always a better alternative