unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: rms@gnu.org
Cc: emacs-devel@gnu.org
Subject: Re: delete-other-frames
Date: Sat, 27 Aug 2016 10:40:29 +0300	[thread overview]
Message-ID: <83inumd5hu.fsf@gnu.org> (raw)
In-Reply-To: <E1bdSUT-00059T-8W@fencepost.gnu.org> (message from Richard Stallman on Fri, 26 Aug 2016 21:32:57 -0400)

> From: Richard Stallman <rms@gnu.org>
> cc: emacs-devel@gnu.org
> Date: Fri, 26 Aug 2016 21:32:57 -0400
> 
>   >   This function deletes the frame @var{frame}.
> 
> The latter is the grammatically correct way.  A parameter name in
> italics, such as "@var{frame}", acts as a _name_ that refers to the
> actual value of the argument.

(In Info files, the parameter is just up-cased, it isn't in italics.)

If the name of the argument is different, I don't object to the latter
form, provided that it has the comma.  But when it is the same word,
the result reads as incorrect English, especially when there's no
comma between them, as things usually stand.

> Just as we would write
> 
>   Send it to my assistant, Jeanne.
> 
> we should write,
> 
>   delete the frame, @var{f}.
> 
> or
> 
>   delete the frame, @var{frame}.

But

  Send it to my assistant ASSISTANT.

and

  delete the frame FRAME

don't sound right to me.  The speller even highlights them as
mis-spellings, because it flags repeated adjacent words.  (It doesn't
when there's a comma between them.)

An additional advantage of my proposal is that it goes well with the
style we use in the doc strings, because the form I proposed is
shorter.

In any case, we have quite a few of instances in our documentation
that use the form I proposed, so if we really think it's incorrect (I
don't agree), we have to change them all first.



  reply	other threads:[~2016-08-27  7:40 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-08-23  8:19 delete-other-frames martin rudalics
2016-08-23 14:09 ` delete-other-frames Eli Zaretskii
2016-08-23 17:56   ` delete-other-frames Richard Copley
2016-08-23 18:31     ` delete-other-frames Eli Zaretskii
2016-08-23 19:55       ` delete-other-frames Richard Copley
2016-08-24  9:07     ` delete-other-frames martin rudalics
2016-08-24  9:06   ` delete-other-frames martin rudalics
2016-08-25  9:16     ` delete-other-frames martin rudalics
2016-08-25 14:46       ` delete-other-frames Eli Zaretskii
2016-08-27  1:32         ` delete-other-frames Richard Stallman
2016-08-27  7:40           ` Eli Zaretskii [this message]
     [not found]         ` <<E1bdSUT-00059T-8W@fencepost.gnu.org>
2016-08-27  6:31           ` delete-other-frames Drew Adams
2016-08-27  7:45             ` delete-other-frames Eli Zaretskii
2016-08-27 21:45             ` delete-other-frames Richard Stallman
     [not found]           ` <<49a2a9c7-8573-4f07-897f-3eb444679d8a@default>
     [not found]             ` <<E1bdlPn-0005Ch-I4@fencepost.gnu.org>
2016-08-28  0:41               ` delete-other-frames Drew Adams
     [not found] <<<57BC072F.9070704@gmx.at>
     [not found] <<57BC072F.9070704@gmx.at>

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=83inumd5hu.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=rms@gnu.org \
    /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).