bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: Eli Zaretskii
Subject: bug#58493: [PATCH] * lisp/play/zone.el (zone): Allow selecting a program
Date: Fri, 14 Oct 2022 13:36:32 +0300

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

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





reply via email to

[Prev in Thread] Current Thread [Next in Thread]