From 837c31f8306d5e21689e325807ef2fff4e5bae9e Mon Sep 17 00:00:00 2001 From: Lars Magne Ingebrigtsen Date: Thu, 14 Jul 2011 01:48:35 +0200 Subject: Fstring_to_char doc clarification * editfns.c (Fstring_to_char): Clarify just what is returned (bug#6576). Text by Eli Zaretskii. --- src/editfns.c | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'src/editfns.c') diff --git a/src/editfns.c b/src/editfns.c index bb36d0dee7..6df4435275 100644 --- a/src/editfns.c +++ b/src/editfns.c @@ -194,8 +194,12 @@ DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0, } DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0, - doc: /* Convert arg STRING to a character, the first character of that string. -A multibyte character is handled correctly. */) + doc: /* Return the first character in STRING. +A multibyte character is handled correctly. +The value returned is a Unicode codepoint if it is below #x110000 (in +hex). Codepoints beyond that are Emacs extensions of Unicode. In +particular, eight-bit characters are returned as codepoints in the +range #x3FFF80 through #x3FFFFF, inclusive. */) (register Lisp_Object string) { register Lisp_Object val; -- cgit v1.2.3