[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#6576: documentation `string-to-char' is incorrect
From: |
Eli Zaretskii |
Subject: |
bug#6576: documentation `string-to-char' is incorrect |
Date: |
Wed, 07 Jul 2010 10:12:30 +0300 |
> Date: Tue, 6 Jul 2010 17:34:41 -0400
> From: MON KEY <monkey@sandpframing.com>
> Cc:
>
> First sentence of doc string for `string-to-char' is incorrect.
>
> ,---- (documentation 'string-to-char )
> | "Convert arg STRING to a character, the first character of that
> | string. A multibyte character is handled correctly.
> |
> | (fn STRING)"
> `----
>
> Should be something more like:
>
> "Return decimal integer value of first character in STRING."
The "decimal" thing has no place here, because we are not talking
about the printed representation of that integer.
I would suggest the following, which also takes care of the second
sentence in the current doc string:
"Return the Unicode codepoint of the first character of STRING.
Note: eight-bit characters are returned as single-byte values in the
range 160 to 255, inclusive."