[Emacs-diffs] /srv/bzr/emacs/trunk r105184: Fstring_to_char doc clarification

[Lars Magne Ingebrigtsen]

------------------------------------------------------------
revno: 105184
committer: Lars Magne Ingebrigtsen <address@hidden>
branch nick: trunk
timestamp: Thu 2011-07-14 01:48:35 +0200
message:
  Fstring_to_char doc clarification
  
  * editfns.c (Fstring_to_char): Clarify just what is returned
  (bug#6576).  Text by Eli Zaretskii.
modified:
  src/ChangeLog
  src/editfns.c

=== modified file 'src/ChangeLog'
--- a/src/ChangeLog     2011-07-13 20:33:44 +0000
+++ b/src/ChangeLog     2011-07-13 23:48:35 +0000
@@ -1,3 +1,8 @@
+2011-07-13  Lars Magne Ingebrigtsen  <address@hidden>
+
+       * editfns.c (Fstring_to_char): Clarify just what is returned
+       (bug#6576).  Text by Eli Zaretskii.
+
 2011-07-13  Juanma Barranquero  <address@hidden>
 
        * gnutls.c (init_gnutls_functions): Honor gnutls_log_level (bug#9059).

=== modified file 'src/editfns.c'
--- a/src/editfns.c     2011-07-04 07:44:38 +0000
+++ b/src/editfns.c     2011-07-13 23:48:35 +0000
@@ -194,8 +194,12 @@
 }
 
 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;