From: Jeff King <peff@peff.net>
Date: Thu, 18 Jul 2019 20:17:43 GMT
Subject: Re: [PATCH 0/1] Fix rendering of text in angle brackets in README.md
Message-ID: <20190718201742.GA22038@sigill.intra.peff.net>
In-Reply-To: <pull.289.git.gitgitgadget@gmail.com>

On Thu, Jul 18, 2019 at 12:08:45PM -0700, Doug Ilijev via GitGitGadget wrote:

> Markdown incorrectly interpreted <commandname> as an HTML tag; use backticks
> to escape Documentation/git-<commandname>.txt to ensure that it renders the
> text as intended.
> 
> An alternative would be to HTML-escape the angle-brackets, at the cost of
> readability of the markdown in plaintext form. I opted for the backticks to
> preserve plaintext readability.

Yeah, I think backticks are the best solution; they match what we do
later in that same paragraph.

This kind of "an alternative..." explanation would go very well in the
actual commit message, too. :) Other than that nit, the patch looks good
to me.

-Peff