From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#55408: Explain the word "interactively" in the Emacs Manual Date: Sun, 15 May 2022 16:15:45 +0300 Message-ID: <83k0anj5ry.fsf@gnu.org> References: <83pmkglcw3.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="36442"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 55408@debbugs.gnu.org To: Stefan Kangas Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun May 15 15:17:10 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nqE7S-0009MD-H8 for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 15 May 2022 15:17:10 +0200 Original-Received: from localhost ([::1]:35536 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nqE7R-0007Ii-0u for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 15 May 2022 09:17:09 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:54658) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nqE7K-0007IH-Ff for bug-gnu-emacs@gnu.org; Sun, 15 May 2022 09:17:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:54871) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nqE7K-0006xf-2l for bug-gnu-emacs@gnu.org; Sun, 15 May 2022 09:17:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nqE7J-0002Cg-S8 for bug-gnu-emacs@gnu.org; Sun, 15 May 2022 09:17:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 15 May 2022 13:17:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 55408 X-GNU-PR-Package: emacs Original-Received: via spool by 55408-submit@debbugs.gnu.org id=B55408.16526205688376 (code B ref 55408); Sun, 15 May 2022 13:17:01 +0000 Original-Received: (at 55408) by debbugs.gnu.org; 15 May 2022 13:16:08 +0000 Original-Received: from localhost ([127.0.0.1]:48767 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nqE6S-0002B2-72 for submit@debbugs.gnu.org; Sun, 15 May 2022 09:16:08 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:32998) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nqE6P-0002AM-7p for 55408@debbugs.gnu.org; Sun, 15 May 2022 09:16:07 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:47442) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nqE6J-0006iX-RA; Sun, 15 May 2022 09:15:59 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From: Date; bh=OtlUSrYI95dpqv9oPdHlHl5o3l5HyBBK/Z8qL/A+IpE=; b=LV651xesHxN/dxglKBae t2b9HUEWSjl3TLc0pe7UWWkPLeqGlWelBNbb1KZLXMiZts3mwzcM8Nl/csYd/2qcb2HxIHjjtlXbj x+gPsw5QjvO66dUM74npVMzDC3WiUeH7mtbpoQbJ7A55Jqo3HcUelVS7TeY0+AGy6wyBhWrbAHAYv nuORYRGs85X1DbN42+mdMssO4OrJegGsV8Q+m3v5tT1Syt2fEbuzjnfFFWdgyZeSVSmuSmj7f2mRR Ba/mffyr9mKBBQAd/pe37DzDCM8GV/kwd1dXK53G8Tls89Ep4QuPmz1T6TQIUjBL0hrz1uh7jWMUe aoJys7CLgjsT1A==; Original-Received: from [87.69.77.57] (port=3534 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nqE6J-0001Gb-4s; Sun, 15 May 2022 09:15:59 -0400 In-Reply-To: (message from Stefan Kangas on Sun, 15 May 2022 14:20:41 +0200) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:232309 Archived-At: > From: Stefan Kangas > Date: Sun, 15 May 2022 14:20:41 +0200 > Cc: 55408@debbugs.gnu.org > > Eli Zaretskii 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.