; * lisp/emacs-lisp/subr-x.el (string-limit): Clarify doc string.

This commit is contained in:
Eli Zaretskii 2022-07-05 19:45:35 +03:00
parent 23e4a30da2
commit 99872bedf0

View 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