{"thread":{"id":"51495","subject":"[PATCH 0/1] Fix rendering of text in angle brackets in README.md","startedAt":"2019-07-18T19:08:48Z","lastAt":"2019-07-18T20:17:46Z","messageCount":3,"participants":["Doug Ilijev via GitGitGadget","Jeff King"],"isPatch":true,"patchVersion":1,"patchTotal":1},"messages":[{"id":"379072","messageId":"pull.289.git.gitgitgadget@gmail.com","threadId":"51495","inReplyTo":null,"subject":"[PATCH 0/1] Fix rendering of text in angle brackets in README.md","fromName":"Doug Ilijev via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-07-18T19:08:45Z","receivedAt":"2019-07-18T19:08:48Z","isPatch":true,"sender":{"key":"name:Doug Ilijev","avatar":null},"body":"Markdown incorrectly interpreted <commandname> as an HTML tag; use backticks\nto escape Documentation/git-<commandname>.txt to ensure that it renders the\ntext as intended.\n\nAn alternative would be to HTML-escape the angle-brackets, at the cost of\nreadability of the markdown in plaintext form. I opted for the backticks to\npreserve plaintext readability.\n\nDoug Ilijev (1):\n  README: fix rendering of text in angle brackets\n\n README.md | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\n\nbase-commit: 9d418600f4d10dcbbfb0b5fdbc71d509e03ba719\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-289%2Fdilijev%2Fpatch-1-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-289/dilijev/patch-1-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/289\n-- \ngitgitgadget\n"},{"id":"379073","messageId":"439190dd3a24ac4c9d6300e68cc15c45e3d0fea8.1563476924.git.gitgitgadget@gmail.com","threadId":"51495","inReplyTo":"pull.289.git.gitgitgadget@gmail.com","subject":"[PATCH 1/1] README: fix rendering of text in angle brackets","fromName":"Doug Ilijev via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2019-07-18T19:08:45Z","receivedAt":"2019-07-18T19:08:49Z","isPatch":true,"sender":{"key":"name:Doug Ilijev","avatar":null},"body":"From: Doug Ilijev <doug.ilijev@gmail.com>\n\nMarkdown incorrectly interpreted `<commandname>` as an HTML tag;\nuse backticks to escape `Documentation/git-<commandname>.txt` to ensure\nthat it renders the text as intended.\n\nSigned-off-by: Doug Ilijev <doug.ilijev@gmail.com>\n---\n README.md | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/README.md b/README.md\nindex 88f126184c..e1d2b82209 100644\n--- a/README.md\n+++ b/README.md\n@@ -19,7 +19,7 @@ including full documentation and Git related tools.\n \n See [Documentation/gittutorial.txt][] to get started, then see\n [Documentation/giteveryday.txt][] for a useful minimum set of commands, and\n-Documentation/git-<commandname>.txt for documentation of each command.\n+`Documentation/git-<commandname>.txt` for documentation of each command.\n If git has been correctly installed, then the tutorial can also be\n read with `man gittutorial` or `git help tutorial`, and the\n documentation of each command with `man git-<commandname>` or `git help\n-- \ngitgitgadget\n"},{"id":"379077","messageId":"20190718201742.GA22038@sigill.intra.peff.net","threadId":"51495","inReplyTo":"pull.289.git.gitgitgadget@gmail.com","subject":"Re: [PATCH 0/1] Fix rendering of text in angle brackets in README.md","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2019-07-18T20:17:43Z","receivedAt":"2019-07-18T20:17:46Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Thu, Jul 18, 2019 at 12:08:45PM -0700, Doug Ilijev via GitGitGadget wrote:\n\n> Markdown incorrectly interpreted <commandname> as an HTML tag; use backticks\n> to escape Documentation/git-<commandname>.txt to ensure that it renders the\n> text as intended.\n> \n> An alternative would be to HTML-escape the angle-brackets, at the cost of\n> readability of the markdown in plaintext form. I opted for the backticks to\n> preserve plaintext readability.\n\nYeah, I think backticks are the best solution; they match what we do\nlater in that same paragraph.\n\nThis kind of \"an alternative...\" explanation would go very well in the\nactual commit message, too. :) Other than that nit, the patch looks good\nto me.\n\n-Peff\n"}]}