all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Lars Ingebrigtsen <larsi@gnus.org>
To: Stefan Kangas <stefan@marxist.se>
Cc: Eli Zaretskii <eliz@gnu.org>, 55408@debbugs.gnu.org
Subject: bug#55408: Explain the word "interactively" in the Emacs Manual
Date: Sun, 15 May 2022 15:34:58 +0200	[thread overview]
Message-ID: <87a6bij4vx.fsf@gnus.org> (raw)
In-Reply-To: <CADwFkmmn8sFNiV4bJMOXDp19bxxopMyGW3DUXMow86zzGmZqOA@mail.gmail.com> (Stefan Kangas's message of "Sun, 15 May 2022 14:20:41 +0200")

Stefan Kangas <stefan@marxist.se> writes:

> The docstring of `package-update-all' currently says: "Interactively,
> QUERY is always true."  AFAIU, this is short for "When called
> interactively," which is more clear but still not as clear as it could
> be.

Yes, that could be clearer; please go ahead and alter.

> In general, perhaps docstrings should prefer something like "When
> used as a command," instead of "When called interactively,".

I'm not sure that's an improvement.  Yes, we do use "command" with a
clear meaning in some parts (like in `describe-command'), but I think
"called interactively" is probably more immediately understandable to
most people who've used Emacs a bit.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no





  parent reply	other threads:[~2022-05-15 13:34 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-14  8:16 bug#55408: Explain the word "interactively" in the Emacs Manual Stefan Kangas
2022-05-14  8:46 ` Eli Zaretskii
2022-05-15 12:20   ` Stefan Kangas
2022-05-15 13:15     ` Eli Zaretskii
2022-05-15 15:12       ` Drew Adams
2022-05-15 13:34     ` Lars Ingebrigtsen [this message]
2022-05-15 15:00       ` Stefan Kangas
2022-05-15 15:07     ` Drew Adams

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=87a6bij4vx.fsf@gnus.org \
    --to=larsi@gnus.org \
    --cc=55408@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=stefan@marxist.se \
    /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.