Re: [PATCH 3/6] git-check-ref-format.txt: avoid single quote

From: Jeff King <peff@peff.net>
Date: May 14, 2021, 05:30 UTC
Message-ID: <YJ4K4UXh6sva5I4H@coredump.intra.peff.net>
In-Reply-To: <f2a78267fd0f424c5cfa6969c891597af4d5171f.1620928059.git.martin.agren@gmail.com>

On Thu, May 13, 2021 at 08:17:42PM +0200, Martin Ågren wrote:

Show 7 quoted lines

> -. A colon `:` is used as in `srcref:dstref` to mean "use srcref\'s
> -  value and store it in dstref" in fetch and push operations.
> +. A colon `:` is used as in `srcref:dstref` to mean "use the value
> +  of `srcref` and store it in `dstref`" in fetch and push operations.
>    It may also be used to select a specific object such as with
> -  'git cat-file': "git cat-file blob v1.3.3:refs.c".
> +  'git cat-file': `git cat-file blob v1.3.3:refs.c`.

I'd perhaps write:

  `srcref`'s value...

but I'm a little afraid to see how it is handled by the various parsers (I'd write it because it does look OK in most markdown parsers I've used).

That said, I think in this case "value of `srcref`" is actually an improvement to the text (but I wouldn't say the same of the earlier patches, which feel like they are making things clunkier).

-Peff