all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 14577@debbugs.gnu.org
Subject: bug#14577: 24.3.50; doc string of `interactive' is wrong
Date: Sat, 8 Jun 2013 08:48:59 -0700 (PDT)	[thread overview]
Message-ID: <183e6772-04ba-46ad-8aeb-0cb584ca4c53@default> (raw)

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'





             reply	other threads:[~2013-06-08 15:48 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-06-08 15:48 Drew Adams [this message]
2016-04-28 22:18 ` bug#14577: 24.3.50; doc string of `interactive' is wrong Lars Ingebrigtsen

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=183e6772-04ba-46ad-8aeb-0cb584ca4c53@default \
    --to=drew.adams@oracle.com \
    --cc=14577@debbugs.gnu.org \
    /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.