unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Richard Stallman <rms@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: Lowercase "arg" in doc strings.
Date: Mon, 22 May 2006 16:37:41 -0400	[thread overview]
Message-ID: <E1FiH9p-0001O3-2y@fencepost.gnu.org> (raw)
In-Reply-To: <v9mzdai3q4.fsf@marauder.physik.uni-ulm.de> (message from Reiner Steib on Mon, 22 May 2006 15:33:23 +0200)

    -With prefix arg, kill that many lines starting from the current line.
    -If arg is negative, kill backward.  Also kill the preceding newline,
    +With prefix ARG, kill that many lines starting from the current line.

Using ARG in upper case in this doc string is a good change, but it's
not correct to say "prefix ARG", because that implies ARG is a prefix.
It isn't a prefix, it is a prefix argument (often abbreviated "prefix
arg").

If you change that to "With prefix arg ARG", then it would be correct.
However, it might be clearer overall if you replace ARG with COUNT or N.

    -With arg, set read-only iff arg is positive.
    +With ARG, set read-only iff ARG is positive.

The current text makes sense; it is a terse way of saying "with a
prefix argument".  The proposed changed text does not make sense.  You
need to do this some other way.

In general, "arg" is an English noun, an abbreviation of "argument".
"ARG" is a proper name, the name of one particular argument.  They do
not have the same meaning, and they cannot be used in the same
contexts, so you cannot just replace one with the other.  To make the
text use ARG, you need to rewrite it so that it makes sense and still
says the other things it needs to say.

      parent reply	other threads:[~2006-05-22 20:37 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-05-22 13:33 Lowercase "arg" in doc strings Reiner Steib
2006-05-22 14:52 ` Andreas Schwab
2006-05-22 20:37 ` Richard Stallman [this message]

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=E1FiH9p-0001O3-2y@fencepost.gnu.org \
    --to=rms@gnu.org \
    --cc=emacs-devel@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).