From: Lars Ingebrigtsen <larsi@gnus.org>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 13373@debbugs.gnu.org
Subject: bug#13373: 24.3.50; doc string of `execute-extended-command' is incorrect
Date: Sat, 08 Feb 2014 05:14:06 -0800 [thread overview]
Message-ID: <87y51lpx0h.fsf@building.gnus.org> (raw)
In-Reply-To: <9C4F75D8489349839D5B5F312F55B023@us.oracle.com> (Drew Adams's message of "Sun, 6 Jan 2013 17:02:10 -0800")
"Drew Adams" <drew.adams@oracle.com> writes:
> The doc string is incorrect and misleading in several ways.
>
> Read function name, then read its arguments and call it.
>
> To pass a numeric argument to the command you are invoking with, specify
> the numeric argument to this command.
>
> Noninteractively, the argument PREFIXARG is the prefix argument to
> give to the command you invoke, if it asks for an argument.
>
> 1. It is not just a function name that is read. It is (it must be) a
> COMMAND name, i.e., an interactive function.
>
> 2. `execute-extended-command' does NOT read the arguments of the
> "function name" it reads. First, a function NAME does not have any
> arguments. Second, it is the command so named that reads its own
> arguments, if any are read. `e-e-c' does nothing of the kind.
>
> 3. (What prompted me to write this bug report.) It is not about passing
> a "numeric argument" to the command invoked by `e-e-c'. It is about
> passing it THE prefix argument, in fact the RAW prefix argument.
>
> There is a LOT of confusion in this doc string. Almost everything it
> says is wrong or misleading.
>
> [Also:
>
> 4. There is no reason to skip a line after the first doc line. That is
> not the Emacs convention.
>
> 5. The second sentence is grammatically incorrect. "...to the command
> you are invoking with" - invoking WITH? invoking with what?
>
> 6. The third sentence is confusing. "if it asks for an argument". No
> command ever asks the user for a prefix argument. Presumably what is
> meant is "if it accepts a prefix argument."
>
> Anyway, the second and third sentences are verbose and somewhat
> repetitive.]
Fixed on trunk.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog http://lars.ingebrigtsen.no/
prev parent reply other threads:[~2014-02-08 13:14 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-01-07 1:02 bug#13373: 24.3.50; doc string of `execute-extended-command' is incorrect Drew Adams
2013-01-07 21:27 ` Aaron S. Hawley
2013-01-07 22:29 ` Drew Adams
2013-01-07 23:08 ` Aaron S. Hawley
2013-01-07 23:59 ` Drew Adams
2014-02-08 13:14 ` Lars Ingebrigtsen [this message]
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=87y51lpx0h.fsf@building.gnus.org \
--to=larsi@gnus.org \
--cc=13373@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
/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.