Fstring_to_char doc clarification

* editfns.c (Fstring_to_char): Clarify just what is returned
(bug#6576).  Text by Eli Zaretskii.

diff --git a/src/ChangeLog b/src/ChangeLog
index a045a7ddd21ff9bb1882cf27351425530ccc24f1..36a7539b8886818631e589dd1467f51d0d75fc97 100644 (file)
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,8 @@
+2011-07-13  Lars Magne Ingebrigtsen  <larsi@gnus.org>
+
+       * editfns.c (Fstring_to_char): Clarify just what is returned
+       (bug#6576).  Text by Eli Zaretskii.
+
 2011-07-13  Juanma Barranquero  <lekktu@gmail.com>
 
        * gnutls.c (init_gnutls_functions): Honor gnutls_log_level (bug#9059).

diff --git a/src/editfns.c b/src/editfns.c
index bb36d0dee71d2da4a0cfbc88b60aeeed79dfff94..6df44352756e532090bd18e9ad8f6034ce35106e 100644 (file)
--- 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;