bug#58493: [PATCH] * lisp/play/zone.el (zone): Allow selecting a program

[Philip Kaludercic]

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.