From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Magne Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#9493: 24.0.50; doc string of `read-from-string' Date: Mon, 19 Sep 2011 10:27:49 +0200 Message-ID: References: <0910A18AA79442059A35060DB1EC764C@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: dough.gmane.org 1316421138 10708 80.91.229.12 (19 Sep 2011 08:32:18 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Mon, 19 Sep 2011 08:32:18 +0000 (UTC) Cc: 9493@debbugs.gnu.org To: "Drew Adams" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Sep 19 10:32:13 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1R5ZGt-0008JX-H7 for geb-bug-gnu-emacs@m.gmane.org; Mon, 19 Sep 2011 10:32:11 +0200 Original-Received: from localhost ([::1]:42158 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1R5ZGt-0005Vt-2N for geb-bug-gnu-emacs@m.gmane.org; Mon, 19 Sep 2011 04:32:11 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:54031) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1R5ZGm-0005VC-HI for bug-gnu-emacs@gnu.org; Mon, 19 Sep 2011 04:32:08 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1R5ZGk-0007Dt-Ty for bug-gnu-emacs@gnu.org; Mon, 19 Sep 2011 04:32:04 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:44712) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1R5ZGk-0007Dp-Pu for bug-gnu-emacs@gnu.org; Mon, 19 Sep 2011 04:32:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1R5ZLa-00067c-DO for bug-gnu-emacs@gnu.org; Mon, 19 Sep 2011 04:37:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Magne Ingebrigtsen Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 19 Sep 2011 08:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 9493 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 9493-submit@debbugs.gnu.org id=B9493.131642140023503 (code B ref 9493); Mon, 19 Sep 2011 08:37:02 +0000 Original-Received: (at 9493) by debbugs.gnu.org; 19 Sep 2011 08:36:40 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1R5ZLB-00066z-BE for submit@debbugs.gnu.org; Mon, 19 Sep 2011 04:36:39 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1R5ZL8-00066q-28 for 9493@debbugs.gnu.org; Mon, 19 Sep 2011 04:36:35 -0400 Original-Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=stories.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1R5ZG8-0007Me-Fm; Mon, 19 Sep 2011 10:31:24 +0200 In-Reply-To: <0910A18AA79442059A35060DB1EC764C@us.oracle.com> (Drew Adams's message of "Tue, 13 Sep 2011 09:18:39 -0700") User-Agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) X-Now-Playing: Patrick Cowley & Jorge Socarras's _Catholic_: "I Never Want To Fall In Love" X-MailScanner-ID: 1R5ZG8-0007Me-Fm MailScanner-NULL-Check: 1317025884.55202@TLttjsExNbE28NIdD9J1Ug X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Mon, 19 Sep 2011 04:37:02 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 1) X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:51456 Archived-At: "Drew Adams" 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/