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#14577: 24.3.50; doc string of `interactive' is wrong Date: Sat, 8 Jun 2013 08:48:59 -0700 (PDT) Message-ID: <183e6772-04ba-46ad-8aeb-0cb584ca4c53@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1370706607 4855 80.91.229.3 (8 Jun 2013 15:50:07 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 8 Jun 2013 15:50:07 +0000 (UTC) To: 14577@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Jun 08 17:50:06 2013 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1UlLOz-0006C6-9C for geb-bug-gnu-emacs@m.gmane.org; Sat, 08 Jun 2013 17:50:01 +0200 Original-Received: from localhost ([::1]:46942 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UlLOy-00009S-Ms for geb-bug-gnu-emacs@m.gmane.org; Sat, 08 Jun 2013 11:50:00 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:51799) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UlLOv-00008F-05 for bug-gnu-emacs@gnu.org; Sat, 08 Jun 2013 11:49:57 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UlLOu-00086M-0E for bug-gnu-emacs@gnu.org; Sat, 08 Jun 2013 11:49:56 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:41943) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UlLOt-00086G-Ti for bug-gnu-emacs@gnu.org; Sat, 08 Jun 2013 11:49:55 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1UlLP0-0004Bi-22 for bug-gnu-emacs@gnu.org; Sat, 08 Jun 2013 11:50:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 08 Jun 2013 15:50:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 14577 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.137070656315953 (code B ref -1); Sat, 08 Jun 2013 15:50:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 8 Jun 2013 15:49:23 +0000 Original-Received: from localhost ([127.0.0.1]:58534 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UlLOM-00049F-QL for submit@debbugs.gnu.org; Sat, 08 Jun 2013 11:49:23 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:49939) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UlLOK-00048g-By for submit@debbugs.gnu.org; Sat, 08 Jun 2013 11:49:21 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UlLO6-00080z-Mj for submit@debbugs.gnu.org; Sat, 08 Jun 2013 11:49:08 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:46256) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UlLO6-00080u-Jd for submit@debbugs.gnu.org; Sat, 08 Jun 2013 11:49:06 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:51658) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UlLO4-0008WA-ON for bug-gnu-emacs@gnu.org; Sat, 08 Jun 2013 11:49:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UlLO3-0007zj-RH for bug-gnu-emacs@gnu.org; Sat, 08 Jun 2013 11:49:04 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:29638) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UlLO3-0007zc-LR for bug-gnu-emacs@gnu.org; Sat, 08 Jun 2013 11:49:03 -0400 Original-Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94]) by aserp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id r58Fn1GY017036 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Sat, 8 Jun 2013 15:49:02 GMT Original-Received: from userz7022.oracle.com (userz7022.oracle.com [156.151.31.86]) by ucsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r58Fn1FJ016742 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Sat, 8 Jun 2013 15:49:01 GMT Original-Received: from abhmt105.oracle.com (abhmt105.oracle.com [141.146.116.57]) by userz7022.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r58Fn0qd016724 for ; Sat, 8 Jun 2013 15:49:00 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.7 (607090) [OL 12.0.6668.5000 (x86)] X-Source-IP: ucsinet22.oracle.com [156.151.31.94] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x 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:74895 Archived-At: The doc string confuses wrt its optional argument. Please refer to (elisp) `Using Interactive' for a proper description, the essentials of which can be used to fix the doc string. 1. There is one optional argument, which should not be called ARGS, as that confuses things. If there is an argument for `interactive' then there is only one. The optional argument to `interactive' provides the arguments to the command. The Elisp manual calls the `interactive' argument ARG-DESCRIPTOR, which is OK. 2. "To get several arguments" - Again, such language is misleading/confusing. The doc string tries to use "argument" in more than one sense, without distinguishing or defining them. IOW, if you want to speak about the arguments that get passed to the command (not to `interactive'), then be careful about the wording. 3. "it is evaluated to get a list of arguments to pass to the function". Say "command", not "function", here, to avoid confusion with the argument to `interactive'. Better is to avoid such language altogether. In GNU Emacs 24.3.50.1 (i386-mingw-nt6.1.7601) of 2013-06-01 on ODIEONE Bzr revision: 112809 xfq.free@gmail.com-20130601123514-of64qkop6z48i3ko Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --with-gcc (4.7) --no-opt --enable-checking --cflags -IC:/Devel/emacs/build/include --ldflags -LC:/Devel/emacs/build/lib'