[0/1] Fix rendering of text in angle brackets in README.md

Message

Johannes Schindelin via GitGitGadget July 18, 2019, 7:08 p.m. UTC

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.

Doug Ilijev (1):
  README: fix rendering of text in angle brackets

 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: 9d418600f4d10dcbbfb0b5fdbc71d509e03ba719
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-289%2Fdilijev%2Fpatch-1-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-289/dilijev/patch-1-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/289

Comments

Jeff King July 18, 2019, 8:17 p.m. UTC | #1

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