summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2022-06-04 10:06:43 +0300
committerEli Zaretskii <eliz@gnu.org>2022-06-04 10:06:43 +0300
commit92c5faafd7aac9b2382939fefd2cdf54f386a8e3 (patch)
treeb5e717e1503c0d93b12351d68311c930ccacc23e
parent284851265423e875d6de963922f3deb536aa2882 (diff)
downloademacs-92c5faafd7aac9b2382939fefd2cdf54f386a8e3.tar.gz
emacs-92c5faafd7aac9b2382939fefd2cdf54f386a8e3.tar.bz2
emacs-92c5faafd7aac9b2382939fefd2cdf54f386a8e3.zip
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)
-rw-r--r--doc/lispref/nonascii.texi11
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi
index d7d25dc36af..6dc23637a79 100644
--- a/doc/lispref/nonascii.texi
+++ b/doc/lispref/nonascii.texi
@@ -280,11 +280,12 @@ to the codepoints @code{#x3FFF80} through @code{#x3FFFFF}, inclusive
@defun string-to-unibyte string
This function returns a unibyte string containing the same sequence of
-characters as @var{string}. It signals an error if @var{string}
-contains a non-@acronym{ASCII} character. If @var{string} is a
-unibyte string, it is returned unchanged. Use this function for
-@var{string} arguments that contain only @acronym{ASCII} and eight-bit
-characters.
+characters as @var{string}. If @var{string} is a unibyte string, it
+is returned unchanged. Otherwise, @acronym{ASCII} characters and
+characters in the @code{eight-bit} charset are converted to their
+corresponding byte values. Use this function for @var{string}
+arguments that contain only @acronym{ASCII} and eight-bit characters;
+the function signals an error if any other characters are encountered.
@end defun
@defun byte-to-string byte