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

Re: [PATCH] Documentation: Fix inconsistent quotes

From
Jeff King <peff@peff.net>
Date
Apr 29, 2015, 18:51 UTC
Message-ID
<20150429185141.GA32207@peff.net>
In-Reply-To
<1430330932-10578-1-git-send-email-stefan@sevenbyte.org>
On Wed, Apr 29, 2015 at 08:08:52PM +0200, Stefan Tatschner wrote:
> While reading 'man git' I realized that the highlighting of the
> environment variables is not consistent. This patch adds missing single
> quotes and substitutes backticks with the proper quotes as well.

I think this is OK in that it makes things consistent, and chooses the style that is already in the majority.

But IMHO, using backticks looks much better. In the roff-formatted manpages single quotes underline, but backticks use bold. The former is hard to read when the content has underscores. For the HTML, the single quotes produce italics, versus a typewriter font for backticks. Which is...OK, I guess, but I think I like the backtick behavior better.

I think we're wildly inconsistent about this throughout the documentation, though.

-Peff
Previous: Stefan TatschnerNext: Jonathan Nieder
Message 2 of 7 in “Documentation: Fix inconsistent quotes”
  1. Documentation: Fix inconsistent quotesStefan Tatschner, Apr 29, 2015
  2. Jeff KingApr 29, 2015
  3. Jonathan NiederApr 29, 2015
  4. Jeff KingApr 29, 2015
  5. Junio C HamanoApr 29, 2015
  6. Jeff KingApr 29, 2015
  7. Stefan TatschnerMay 14, 2015

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.