From: "Drew Adams" <drew.adams@oracle.com>
To: "'Chong Yidong'" <cyd@stupidchicken.com>,
"'Lars Magne Ingebrigtsen'" <larsi@gnus.org>
Cc: 2035@debbugs.gnu.org
Subject: bug#2035: 23.0.60; doc string of dired-read-shell-command
Date: Tue, 12 Jul 2011 06:53:05 -0700 [thread overview]
Message-ID: <7CB60997E8644DD1BEF0DA4A50943661@us.oracle.com> (raw)
In-Reply-To: <87sjqcb41r.fsf@stupidchicken.com>
> >>> This has apparently already been fixed.
> >>
> >> No, it has not. The doc string has been changed, but the
> >> bug report still applies. Please read it. What about the
> >> prefix argument? This is not a command. How can it have a
> >> prefix argument? Etc.
> >
> > It is passed `current-prefix-arg' in the use cases, so I
> > think that's clear enough.
>
> I fixed the remaining doc issues; closing.
Haven't yet seen your changes, Yidong, but the reply below to Lars apparently
did not make it to the thread - perhaps I forgot to use `Reply All'. I hope its
points were proactively addressed by your fix.
It is incorrect to speak here (at all) about "prefix arg" or
`current-prefix-arg'.
Thx.
> Sent: Monday, July 11, 2011 9:13 AM To: 'Lars Magne Ingebrigtsen'
> Subject: RE: 23.0.60; doc string of dired-read-shell-command
>
> > >> This has apparently already been fixed.
> > >
> > > No, it has not. The doc string has been changed, but the
> > > bug report still applies. Please read it. What about the
> > > prefix argument? This is not a command. How can it have a
> > > prefix argument? Etc.
> >
> > It is passed `current-prefix-arg' in the use cases, so I
> > think that's clear enough.
>
> Only a caller knows what it passes to `dired-read-shell-command'.
> The code for this function, and the doc string for this function,
> make no reference to `current-prefix-arg'.
>
> If the code makes no reference to `current-prefix-arg' and
> yet this function is always supposed to use
> `current-prefix-arg', then it should not be passed as an arg
> but should be hard-coded in the body.
>
> If, OTOH, we want the argument ARG to be able to be something
> other than the value of `current-prefix-arg', then we should
> keep that parameter. And if it is kept it needs to be
> documented. And it must not, in that case, be documented as
> the "prefix arg" or `current-prefix-arg' or any such thing.
> It must be documented in its own right: what is it for? What
> are its possible values?
>
> This should be obvious. This is the approach for any
> function. If we want always the same value, then don't pass
> it as a paramter. If we define a parameter then document it.
prev parent reply other threads:[~2011-07-12 13:53 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-01-25 3:23 bug#2035: 23.0.60; doc string of dired-read-shell-command Drew Adams
2009-02-13 11:49 ` Juanma Barranquero
2009-02-13 15:09 ` Drew Adams
2011-07-11 13:52 ` Lars Magne Ingebrigtsen
2011-07-11 15:25 ` Drew Adams
2011-07-11 15:45 ` Lars Magne Ingebrigtsen
2011-07-12 2:56 ` Chong Yidong
2011-07-12 13:53 ` Drew Adams [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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7CB60997E8644DD1BEF0DA4A50943661@us.oracle.com \
--to=drew.adams@oracle.com \
--cc=2035@debbugs.gnu.org \
--cc=cyd@stupidchicken.com \
--cc=larsi@gnus.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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).