GNU bug report logs - #55408
Explain the word "interactively" in the Emacs Manual

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Stefan Kangas <stefan <at> marxist.se>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#55408: closed (Explain the word "interactively" in the Emacs
 Manual)
Date: Sun, 15 May 2022 15:01:02 +0000

[Message part 1 (text/plain, inline)]

Your message dated Sun, 15 May 2022 17:00:25 +0200
with message-id <CADwFkmmz8d4VCdzCQQ8ZUUDbMf=7=82xWFQtsXw=mcONLoR-Og <at> mail.gmail.com>
and subject line Re: bug#55408: Explain the word "interactively" in the Emacs Manual
has caused the debbugs.gnu.org bug report #55408,
regarding Explain the word "interactively" in the Emacs Manual
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
55408: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=55408
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Stefan Kangas <stefan <at> marxist.se>
To: bug-gnu-emacs <at> gnu.org
Subject: Explain the word "interactively" in the Emacs Manual
Date: Sat, 14 May 2022 10:16:06 +0200

Severity: wishlist

It would be useful if the word "interactively" was explained in the
Emacs manual, and if there was an index entry for it.  Otherwise, it
might be hard to understand a docstring like this one for a new user:

    (defun package-update-all (&optional query)
      "Upgrade all packages.
    If QUERY, ask the user before updating packages.  Interactively,
    QUERY is always true."

Perhaps it should be explained in `(emacs) Commands' and/or in the Glossary?

[Message part 3 (message/rfc822, inline)]

From: Stefan Kangas <stefan <at> marxist.se>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 55408-done <at> debbugs.gnu.org
Subject: Re: bug#55408: Explain the word "interactively" in the Emacs Manual
Date: Sun, 15 May 2022 17:00:25 +0200

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Stefan Kangas <stefan <at> 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.

Done.

> > 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.

OK, I guess since neither you or Eli are too enthusiastic, we can just
leave this as is.  I'm therefore closing this bug.

Thanks for considering the proposal.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.