all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: MON KEY <monkey@sandpframing.com>
To: 6576@debbugs.gnu.org
Subject: bug#6576: documentation `string-to-char' is incorrect
Date: Tue, 6 Jul 2010 17:34:41 -0400	[thread overview]
Message-ID: <AANLkTil7GhkIvUBRZ1QawHAe7BiT16fJTXp4PphN1dke@mail.gmail.com> (raw)

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 rationale for the proposed docstring change are:

- The second clause of sentence doesn't parse;

- The arg string (nor its 1st char) are _not_ converted, e.g.:

  (let ((not-cnvrtd "bubba"))
    (string-to-char not-cnvrtd)
    not-cnvrtd) ;; <- value of not-cnvrtd is a string not a char.

- It is more in keeping with what the manual says:

  ,---- (info "(elisp)Basic Char Syntax")
  | Since characters are really integers, the printed representation
  | of a character is a decimal number.
  `----

Affliced docstring appears in GNU Emacs 23.2.1 and current through
Bzr-100633

--
/s_P\





             reply	other threads:[~2010-07-06 21:34 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-07-06 21:34 MON KEY [this message]
2010-07-07  7:12 ` bug#6576: documentation `string-to-char' is incorrect Eli Zaretskii
2010-07-07  8:40   ` Andreas Schwab
2010-07-07 10:31     ` Eli Zaretskii
2010-07-07 12:16       ` Andreas Schwab
2010-07-07 14:23         ` Eli Zaretskii
2010-07-07 15:46           ` Eli Zaretskii
2011-07-13 23:50             ` Lars Magne Ingebrigtsen
2011-07-14  2:13               ` Chong Yidong
2011-07-14 13:02                 ` Lars Magne Ingebrigtsen
2011-07-14  3:06               ` Eli Zaretskii
2011-07-14 13:00                 ` Lars Magne Ingebrigtsen
2011-07-14 13:34                   ` Eli Zaretskii
2011-07-14 14:06                     ` Lars Magne Ingebrigtsen
2011-07-14 15:59                       ` Eli Zaretskii
2011-07-14 16:12                         ` Lars Magne Ingebrigtsen
2011-07-14 19:37                           ` Eli Zaretskii
2011-07-14 19:39                             ` Lars Magne Ingebrigtsen
2011-07-15 19:06                               ` MON KEY
2011-07-21 18:38                                 ` Chong Yidong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=AANLkTil7GhkIvUBRZ1QawHAe7BiT16fJTXp4PphN1dke@mail.gmail.com \
    --to=monkey@sandpframing.com \
    --cc=6576@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.