From: "Doug Ilijev via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 0/1] Fix rendering of text in angle brackets in README.md
Date: Thu, 18 Jul 2019 12:08:45 -0700 (PDT) [thread overview]
Message-ID: <pull.289.git.gitgitgadget@gmail.com> (raw)
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
--
gitgitgadget
next reply other threads:[~2019-07-18 19:08 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-18 19:08 Doug Ilijev via GitGitGadget [this message]
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 ` [PATCH 0/1] Fix rendering of text in angle brackets in README.md Jeff King
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=pull.289.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--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).