unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Philip Kaludercic <philipk@posteo.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 58493@debbugs.gnu.org, Stefan Kangas <stefankangas@gmail.com>
Subject: bug#58493: [PATCH] * lisp/play/zone.el (zone): Allow selecting a program
Date: Fri, 14 Oct 2022 15:57:29 +0000	[thread overview]
Message-ID: <87a65ygzyu.fsf@posteo.net> (raw)
In-Reply-To: <83r0za8zf3.fsf@gnu.org> (Eli Zaretskii's message of "Fri, 14 Oct 2022 13:36:32 +0300")

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Stefan Kangas <stefankangas@gmail.com>
>> Date: Fri, 14 Oct 2022 11:22:00 +0200
>> Cc: 58493@debbugs.gnu.org
>> 
>> > "... the command prompts the user for a program?"
>> 
>> I think we use the style
>> 
>>     "With a \\[universal-argument] prefix argument, prompt for a program."
>
> No, we rarely if at all mention universal-argument explicitly in doc
> strings.  The assumption is that the reader knows well enough how to
> invoke commands with a prefix argument.

FWIW it wouldn't be bad to do so.  When I first got into Emacs I was
using it for maybe 1 or 1 1/2 years before I understood what prefix
arguments are.  Really improved my experience when I found out :)

>> I would personally put the interactive part first, and then say
>> explicitly:
>> 
>>     "When called from Lisp, ..."
>> 
>> This is a command, first and foremost, after all.
>
> That's a matter of personal preferences.  We have both styles in our
> doc strings, and both are okay, from my POV.

I agree with Stefan that in this case mentioning the interactive case
first is more intuitive.





  reply	other threads:[~2022-10-14 15:57 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-13 13:37 bug#58493: [PATCH] * lisp/play/zone.el (zone): Allow selecting a program Philip Kaludercic
2022-10-13 14:20 ` Stefan Kangas
2022-10-13 15:55 ` Eli Zaretskii
2022-10-13 17:14   ` Philip Kaludercic
2022-10-13 19:26     ` Eli Zaretskii
2022-10-13 20:22       ` Philip Kaludercic
2022-10-14  9:22     ` Stefan Kangas
2022-10-14 10:36       ` Eli Zaretskii
2022-10-14 15:57         ` Philip Kaludercic [this message]
2022-11-04 22:19 ` Philip Kaludercic

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=87a65ygzyu.fsf@posteo.net \
    --to=philipk@posteo.net \
    --cc=58493@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=stefankangas@gmail.com \
    /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).