unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Kangas <stefan@marxist.se>
Cc: 55408@debbugs.gnu.org
Subject: bug#55408: Explain the word "interactively" in the Emacs Manual
Date: Sun, 15 May 2022 16:15:45 +0300	[thread overview]
Message-ID: <83k0anj5ry.fsf@gnu.org> (raw)
In-Reply-To: <CADwFkmmn8sFNiV4bJMOXDp19bxxopMyGW3DUXMow86zzGmZqOA@mail.gmail.com> (message from Stefan Kangas on Sun, 15 May 2022 14:20:41 +0200)

> From: Stefan Kangas <stefan@marxist.se>
> Date: Sun, 15 May 2022 14:20:41 +0200
> Cc: 55408@debbugs.gnu.org
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> > Does it really need to be explained?  It's a word used for its literal
> > meaning.
> 
> IMHO, it is not immediately clear what is meant.
> 
> 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.  In general, perhaps docstrings should prefer something like "When
> used as a command," instead of "When called interactively,".

We use this style in many doc strings.  I'd consider it a standard
Emacs language of describing what happens in interactive invocations,
and presume that any Emacs user knows only too well what it means.
If we change our style, we'd have to change it in many places,
including the manual.

> > The very first line presented in the *Help* buffer says:
> >
> >   package-update-all is an interactive compiled Lisp function in
> >   ‘package.el’.            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> I think it would probably be more helpful if that line said "a
> command" instead of "an interactive compiled Lisp function".

It is both a command and a function.  Every command can be also
invoked non-interactively.  That is what that sentence says, and has
been saying since day one.





  reply	other threads:[~2022-05-15 13:15 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 [this message]
2022-05-15 15:12       ` Drew Adams
2022-05-15 13:34     ` Lars Ingebrigtsen
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

  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=83k0anj5ry.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=55408@debbugs.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 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).