From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs Subject: bug#9493: 24.0.50; doc string of `read-from-string' Date: Tue, 13 Sep 2011 09:18:39 -0700 Message-ID: <0910A18AA79442059A35060DB1EC764C@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: dough.gmane.org 1315930791 16189 80.91.229.12 (13 Sep 2011 16:19:51 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Tue, 13 Sep 2011 16:19:51 +0000 (UTC) To: 9493@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Sep 13 18:19:47 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 1R3Vi4-0007rU-TK for geb-bug-gnu-emacs@m.gmane.org; Tue, 13 Sep 2011 18:19:45 +0200 Original-Received: from localhost ([::1]:59894 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1R3Vi3-0003jL-TP for geb-bug-gnu-emacs@m.gmane.org; Tue, 13 Sep 2011 12:19:43 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:41727) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1R3Vi1-0003j0-4G for bug-gnu-emacs@gnu.org; Tue, 13 Sep 2011 12:19:41 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1R3Vhv-0003xG-3R for bug-gnu-emacs@gnu.org; Tue, 13 Sep 2011 12:19:41 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:47340) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1R3Vhu-0003xC-Vi for bug-gnu-emacs@gnu.org; Tue, 13 Sep 2011 12:19:35 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1R3VmE-0002qy-F2; Tue, 13 Sep 2011 12:24:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 13 Sep 2011 16:24:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 9493 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: Original-Received: via spool by submit@debbugs.gnu.org id=B.131593101210902 (code B ref -1); Tue, 13 Sep 2011 16:24:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 13 Sep 2011 16:23:32 +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 1R3Vlk-0002pn-7l for submit@debbugs.gnu.org; Tue, 13 Sep 2011 12:23:32 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1R3Vlh-0002pX-As for submit@debbugs.gnu.org; Tue, 13 Sep 2011 12:23:30 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1R3VhI-0003tR-Ni for submit@debbugs.gnu.org; Tue, 13 Sep 2011 12:19:01 -0400 Original-Received: from lists.gnu.org ([140.186.70.17]:44321) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1R3VhI-0003tN-MI for submit@debbugs.gnu.org; Tue, 13 Sep 2011 12:18:56 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:41562) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1R3VhD-0003iF-Ub for bug-gnu-emacs@gnu.org; Tue, 13 Sep 2011 12:18:56 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1R3VhC-0003sY-SZ for bug-gnu-emacs@gnu.org; Tue, 13 Sep 2011 12:18:51 -0400 Original-Received: from rcsinet15.oracle.com ([148.87.113.117]:42526) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1R3VhC-0003sL-Jj for bug-gnu-emacs@gnu.org; Tue, 13 Sep 2011 12:18:50 -0400 Original-Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238]) by rcsinet15.oracle.com (Switch-3.4.4/Switch-3.4.4) with ESMTP id p8DGIksE001000 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Tue, 13 Sep 2011 16:18:48 GMT Original-Received: from acsmt358.oracle.com (acsmt358.oracle.com [141.146.40.158]) by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id p8DGIkhO009169 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Tue, 13 Sep 2011 16:18:46 GMT Original-Received: from abhmt108.oracle.com (abhmt108.oracle.com [141.146.116.60]) by acsmt358.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id p8DGIfas000316 for ; Tue, 13 Sep 2011 11:18:41 -0500 Original-Received: from dradamslap1 (/10.159.52.70) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Tue, 13 Sep 2011 09:18:40 -0700 X-Mailer: Microsoft Office Outlook 11 X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6109 Thread-Index: AcxyMMwXFI8+wMgnRFCb12ycjehKdw== X-Source-IP: acsinet22.oracle.com [141.146.126.238] X-Auth-Type: Internal IP X-CT-RefId: str=0001.0A090204.4E6F8268.00FD:SCFMA922111,ss=1,re=-4.000,fgs=0 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 1) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Tue, 13 Sep 2011 12:24: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:51101 Archived-At: 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". In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600) of 2011-09-05 on 3249CTO Windowing system distributor `Microsoft Corp.', version 5.1.2600 configured using `configure --with-gcc (4.5) --no-opt'