all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Marcin Borkowski <mbork@mbork.pl>, John Wiegley <jwiegley@gmail.com>
Cc: emacs-devel <emacs-devel@gnu.org>
Subject: RE: async-shell-command
Date: Mon, 18 Apr 2016 13:09:59 -0700 (PDT)	[thread overview]
Message-ID: <7550baf5-1d20-4f87-83bb-1fd4b3408292@default> (raw)
In-Reply-To: <87k2jubsih.fsf@mbork.pl>

> Also, I'm pretty sure that the current meaning of the prefix argument
> for `async-shell-command' /must/ be documented - it is far from obvious,
> and can be learned only from careful reading of the code.

You need not read the code, but you do need to read the doc
string carefully.  The info about the arguments is available,
but not clearly and directly.

For `async-shell-command' the doc string says:

 "Like `shell-command', but..."

But like it in what ways, one might wonder?  In fact and in
particular, it is like `shell-command' wrt the arguments.

It would be better for this doc string to explicitly refer a
reader to the doc string of `shell-command' for info about
the arguments, including the use of a prefix arg.

> I'm going to prepare such a patch for docs (both the docstring
> and the manual) first.

Thank you.  I'm sure it will be an improvement.

(Note too that the second line of the doc string should not be
blank.  Dunno why some people seem to think it is right to add
such a line.  I suspect that it comes from reading the doc
string only in the Lisp source instead of trying `C-h f'.)



  reply	other threads:[~2016-04-18 20:09 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-04-16  7:54 async-shell-command Marcin Borkowski
2016-04-16 20:44 ` async-shell-command John Wiegley
2016-04-18 19:56   ` async-shell-command Marcin Borkowski
2016-04-18 20:09     ` Drew Adams [this message]
2016-04-19  0:47     ` async-shell-command John Wiegley
2016-04-19 20:30       ` async-shell-command Marcin Borkowski

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=7550baf5-1d20-4f87-83bb-1fd4b3408292@default \
    --to=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    --cc=jwiegley@gmail.com \
    --cc=mbork@mbork.pl \
    /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.