git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Taylor Blau <me@ttaylorr.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Taylor Blau <me@ttaylorr.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>,
	git@vger.kernel.org, wolf@oriole.systems
Subject: Re: [PATCH] rev-parse: fix mismatch quoting of separator in the message
Date: Wed, 22 Sep 2021 15:42:55 -0400	[thread overview]
Message-ID: <YUuHP41V9m7cIEBL@nand.local> (raw)
In-Reply-To: <xmqqzgs45s15.fsf@gitster.g>

On Wed, Sep 22, 2021 at 12:28:22PM -0700, Junio C Hamano wrote:
> Taylor Blau <me@ttaylorr.com> writes:
>
> > On Wed, Sep 22, 2021 at 06:17:45PM +0700, Bagas Sanjaya wrote:
> >> There is a quoting mismatch quoting `--` separator in "no usage string
> >> given...." message (`' instead of ``). Fix it.
> >
> > For what it's worth, I think that the `' style is typographic, since the
> > pair look like English "smart quotes" (as opposed to straight quotes). I
> > have no opinion about which is better, but I don't think the pre-image
> > was necessarily a mistake.
>
> I thought that we try to avoid "smart quotes" in our messages.

I think UTF-8 smart quotes are generally frowned upon in source code,
but I didn't think we had any hard-and-fast rule about whether to prefer
'this' to `that' (for what it's worth, I prefer the former and it seems
to be more common).

> And we do not expect our users to be expecting to read their error
> messages in markdown, so `--` is not a "Fix", either (do we have
> many instances of such uses of backticks in messages already?).

There are many in code comments, but I could only find a handful in
error messages or the description of command-line flags.

Thanks,
Taylor

  reply	other threads:[~2021-09-22 19:43 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-22 11:17 [PATCH] rev-parse: fix mismatch quoting of separator in the message Bagas Sanjaya
2021-09-22 17:40 ` Taylor Blau
2021-09-22 19:28   ` Junio C Hamano
2021-09-22 19:42     ` Taylor Blau [this message]
2021-09-22 19:59       ` Ævar Arnfjörð Bjarmason
2021-09-22 20:08         ` Taylor Blau
2021-09-22 20:58           ` Junio C Hamano

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=YUuHP41V9m7cIEBL@nand.local \
    --to=me@ttaylorr.com \
    --cc=bagasdotme@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=wolf@oriole.systems \
    /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.
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 NNTP newsgroup(s).