From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#14577: 24.3.50; doc string of `interactive' is wrong Date: Fri, 29 Apr 2016 00:18:05 +0200 Message-ID: <8760v14btu.fsf@gnus.org> References: <183e6772-04ba-46ad-8aeb-0cb584ca4c53@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1461881962 5335 80.91.229.3 (28 Apr 2016 22:19:22 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 28 Apr 2016 22:19:22 +0000 (UTC) Cc: 14577@debbugs.gnu.org, 13571@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Apr 29 00:19:11 2016 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 1avuH8-00077x-6C for geb-bug-gnu-emacs@m.gmane.org; Fri, 29 Apr 2016 00:19:10 +0200 Original-Received: from localhost ([::1]:51386 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avuH7-00040C-HI for geb-bug-gnu-emacs@m.gmane.org; Thu, 28 Apr 2016 18:19:09 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:34307) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avuH3-0003vN-Gr for bug-gnu-emacs@gnu.org; Thu, 28 Apr 2016 18:19:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1avuH0-0008Qq-Kg for bug-gnu-emacs@gnu.org; Thu, 28 Apr 2016 18:19:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:41302) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avuH0-0008Ql-Hi for bug-gnu-emacs@gnu.org; Thu, 28 Apr 2016 18:19:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1avuH0-00050B-En for bug-gnu-emacs@gnu.org; Thu, 28 Apr 2016 18:19:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 28 Apr 2016 22:19:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 14577 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 14577-submit@debbugs.gnu.org id=B14577.146188189219157 (code B ref 14577); Thu, 28 Apr 2016 22:19:02 +0000 Original-Received: (at 14577) by debbugs.gnu.org; 28 Apr 2016 22:18:12 +0000 Original-Received: from localhost ([127.0.0.1]:53638 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1avuGB-0004yu-W2 for submit@debbugs.gnu.org; Thu, 28 Apr 2016 18:18:12 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]:38330) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1avuGA-0004yd-7h; Thu, 28 Apr 2016 18:18:10 -0400 Original-Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1avuG5-00010t-Ar; Fri, 29 Apr 2016 00:18:07 +0200 In-Reply-To: <183e6772-04ba-46ad-8aeb-0cb584ca4c53@default> (Drew Adams's message of "Sat, 8 Jun 2013 08:48:59 -0700 (PDT)") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.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" Xref: news.gmane.org gmane.emacs.bugs:117124 Archived-At: Drew Adams writes: > 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. I've now tweaked this on the trunk. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no