git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Jeff King <peff@peff.net>
Date
Jul 18, 2019, 20:17 UTC
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:
Show 7 quoted lines
> 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
Previous: Doug Ilijev via GitGitGadget
Message 3 of 3 in “Fix rendering of text in angle brackets in README.md”
  1. 0/1 Fix rendering of text in angle brackets in README.mdDoug Ilijev via GitGitGadget, Jul 18, 2019
  2. 1/1 README: fix rendering of text in angle bracketsDoug Ilijev via GitGitGadget, Jul 18, 2019
  3. Jeff KingJul 18, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.