git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Doug Ilijev via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH 0/1] Fix rendering of text in angle brackets in README.md
Date: Thu, 18 Jul 2019 16:17:43 -0400	[thread overview]
Message-ID: <20190718201742.GA22038@sigill.intra.peff.net> (raw)
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

      parent reply	other threads:[~2019-07-18 20:17 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-07-18 19:08 [PATCH 0/1] Fix rendering of text in angle brackets in README.md Doug Ilijev via GitGitGadget
2019-07-18 19:08 ` [PATCH 1/1] README: fix rendering of text in angle brackets Doug Ilijev via GitGitGadget
2019-07-18 20:17 ` Jeff King [this message]

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=20190718201742.GA22038@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=gitster@pobox.com \
    /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).