Clarify documentation of 'string-to-unibyte'

* doc/lispref/nonascii.texi (Converting Representations): Clarify
what 'string-to-unibyte' does.  Reported by Richard Hansen
<rhansen@rhansen.org>.  (Bug#55777)
This commit is contained in:
Eli Zaretskii 2022-06-04 10:06:43 +03:00
parent 2848512654
commit 92c5faafd7

View file

@ -280,11 +280,12 @@ to the codepoints @code{#x3FFF80} through @code{#x3FFFFF}, inclusive
@defun string-to-unibyte string @defun string-to-unibyte string
This function returns a unibyte string containing the same sequence of This function returns a unibyte string containing the same sequence of
characters as @var{string}. It signals an error if @var{string} characters as @var{string}. If @var{string} is a unibyte string, it
contains a non-@acronym{ASCII} character. If @var{string} is a is returned unchanged. Otherwise, @acronym{ASCII} characters and
unibyte string, it is returned unchanged. Use this function for characters in the @code{eight-bit} charset are converted to their
@var{string} arguments that contain only @acronym{ASCII} and eight-bit corresponding byte values. Use this function for @var{string}
characters. arguments that contain only @acronym{ASCII} and eight-bit characters;
the function signals an error if any other characters are encountered.
@end defun @end defun
@defun byte-to-string byte @defun byte-to-string byte