unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefankangas@gmail.com>
To: Philip Kaludercic <philipk@posteo.net>, Eli Zaretskii <eliz@gnu.org>
Cc: 58493@debbugs.gnu.org
Subject: bug#58493: [PATCH] * lisp/play/zone.el (zone): Allow selecting a program
Date: Fri, 14 Oct 2022 11:22:00 +0200	[thread overview]
Message-ID: <CADwFkm=rfOpLR9VxAFPo50-+fUEbZWa4+ZDTRrPPrixbDSqe+A@mail.gmail.com> (raw)
In-Reply-To: <87zgdz1w8h.fsf@posteo.net>

Philip Kaludercic <philipk@posteo.net> writes:

> Eli Zaretskii <eliz@gnu.org> writes:
>
>>> From: Philip Kaludercic <philipk@posteo.net>
>>> Date: Thu, 13 Oct 2022 13:37:12 +0000
>>>
>>> +(defun zone (&optional pgm)
>>> +  "Zone out, completely.
>>> +The optional argument PGM should be an element of `zone-programs'
>>> +or nil to have a random element chosen.  When invoked
>>> +interactively with a prefix argument, the user is prompted for a
>>> +program."                             ^^^^^^^^^^^^^^^^^^^^^^^^^^
>>
>> Passive tense alert!
>
> "... the command prompts the user for a program?"

I think we use the style

    "With a \\[universal-argument] prefix argument, prompt for a program."

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.





  parent reply	other threads:[~2022-10-14  9:22 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 [this message]
2022-10-14 10:36       ` Eli Zaretskii
2022-10-14 15:57         ` Philip Kaludercic
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='CADwFkm=rfOpLR9VxAFPo50-+fUEbZWa4+ZDTRrPPrixbDSqe+A@mail.gmail.com' \
    --to=stefankangas@gmail.com \
    --cc=58493@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=philipk@posteo.net \
    /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).