git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Stefan Tatschner <stefan@sevenbyte.org>
Cc: gitster@pobox.com, git@vger.kernel.org
Subject: Re: [PATCH] Documentation: Fix inconsistent quotes
Date: Wed, 29 Apr 2015 14:51:41 -0400	[thread overview]
Message-ID: <20150429185141.GA32207@peff.net> (raw)
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

  reply	other threads:[~2015-04-29 18:51 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-04-29 18:08 [PATCH] Documentation: Fix inconsistent quotes Stefan Tatschner
2015-04-29 18:51 ` Jeff King [this message]
2015-04-29 19:09   ` Jonathan Nieder
2015-04-29 20:04     ` Jeff King
2015-04-29 20:13       ` Junio C Hamano
2015-04-29 20:32         ` Jeff King
2015-05-14  9:14 ` Stefan Tatschner

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=20150429185141.GA32207@peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=stefan@sevenbyte.org \
    /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).