From: Lars Magne Ingebrigtsen <larsi@gnus.org>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 9493@debbugs.gnu.org
Subject: bug#9493: 24.0.50; doc string of `read-from-string'
Date: Mon, 19 Sep 2011 10:27:49 +0200 [thread overview]
Message-ID: <m3hb49gcmy.fsf@stories.gnus.org> (raw)
In-Reply-To: <0910A18AA79442059A35060DB1EC764C@us.oracle.com> (Drew Adams's message of "Tue, 13 Sep 2011 09:18:39 -0700")
"Drew Adams" <drew.adams@oracle.com> writes:
> The return value of this function is the most important info that can be
> conveyed by its doc string. All that is said is that the value returned
> is "a cons: (OBJECT-READ . FINAL-STRING-INDEX)". There is no
> description of either OBJECT-READ (could be guessed, but better to
> specify it) or, especially, FINAL-STRING-INDEX (not obvious at all).
>
> Describe these properly, as is done in the Elisp manual. It is not long
> to say what the manual says for FINAL-STRING-INDEX: "an integer giving
> the position of the next remaining character in the string (i.e., the
> first one not read)." It would be enough to say this: "zero-based
> position of first char not read".
I've now documented FINAL-STRING-INDEX. Saying "OBJECT-READ is the
object read" seems superfluous.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog http://lars.ingebrigtsen.no/
prev parent reply other threads:[~2011-09-19 8:27 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-09-13 16:18 bug#9493: 24.0.50; doc string of `read-from-string' Drew Adams
2011-09-19 8:27 ` Lars Magne Ingebrigtsen [this message]
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=m3hb49gcmy.fsf@stories.gnus.org \
--to=larsi@gnus.org \
--cc=9493@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
/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.