From: Jeff King <peff@peff.net>
To: Jacques Bodin-Hullin <j.bodinhullin@monsieurbiz.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Typo `dashes ?` -> `dashes?`
Date: Mon, 15 Oct 2018 13:20:41 -0400 [thread overview]
Message-ID: <20181015172041.GC1301@sigill.intra.peff.net> (raw)
In-Reply-To: <01020166741c381f-bd183f7f-725d-4b4f-9f5f-804560b2b00b-000000@eu-west-1.amazonses.com>
On Sun, Oct 14, 2018 at 07:44:58PM +0000, Jacques Bodin-Hullin wrote:
> diff --git a/parse-options.c b/parse-options.c
> index 3b874a83a0c89..88512212392ae 100644
> --- a/parse-options.c
> +++ b/parse-options.c
> @@ -352,7 +352,7 @@ static void check_typos(const char *arg, const struct option *options)
> return;
>
> if (starts_with(arg, "no-")) {
> - error ("did you mean `--%s` (with two dashes ?)", arg);
> + error ("did you mean `--%s` (with two dashes?)", arg);
I agree the extra space in the original is stylistically weird, and your
suggestion is an improvement. However, I think this is really a question
"did you mean..." with a parenthetical phrase. Most style guides would
recommend putting the punctuation outside, like:
error: did you mean `--foo` (with two dashes)?
Speaking of style, the extra space between "error" and "(" does not
match our usual coding style. It might be worth removing while we're
touching these lines.
-Peff
next prev parent reply other threads:[~2018-10-15 17:20 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-14 19:44 [PATCH] Typo `dashes ?` -> `dashes?` Jacques Bodin-Hullin
2018-10-15 17:20 ` Jeff King [this message]
[not found] ` <CAAwZSqAk+D-6y9ArT_tAychwLnNUANinLPYX-ciXJDmyv+J7FA@mail.gmail.com>
2018-10-17 8:23 ` Jeff King
2018-11-16 22:58 ` [PATCH-2] Change writing style Jacques Bodin-Hullin
2018-11-17 9:04 ` Junio C Hamano
2020-02-05 13:07 ` [PATCH] parse-options: lose an unnecessary space in an error message Jacques Bodin-Hullin
2020-02-05 18:49 ` Junio C Hamano
2020-02-05 20:11 ` Jacques Bodin-Hullin
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: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20181015172041.GC1301@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=j.bodinhullin@monsieurbiz.com \
/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://80x24.org/mirrors/git.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).