bug#6576: documentation `string-to-char' is incorrect

[Lars Magne Ingebrigtsen <larsi@gnus.org>]

Eli Zaretskii <eliz@gnu.org> writes:

> Actually, there's no way we could return the eight-bit characters in
> the 160 to 255 range, since that range is already taken by Unicode
> codepoints of Latin characters.  So how about
>
>   "Return the codepoint of the first character of STRING.
>
>   Value is the 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."

I've now installed a slight variation on this in Emacs 24.

But after checking it in, I started wondering whether this doc string
really makes sense.  The function returns an Emacs character, and it
would be rather weird if all functions that take or return an Emacs
character goes through that entire explanation.

Is there a specific reason this particular function deserves this
detailed explanation?

If not, I'd rather just revert the change I just checked in...

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/