Re: [PATCH] Fix typos in git-remote.txt and git-symbolic-ref.txt

From: Wesley J. Landaker <wjl@icecavern.net>
Date: Aug 12, 2009, 00:26 UTC
Message-ID: <200908111826.12338.wjl@icecavern.net>
In-Reply-To: <200908110909.33904.trast@student.ethz.ch>

On Tuesday 11 August 2009 01:09:32 Thomas Rast wrote:

> So until we know for certain that they're not needed, I'd rather not
> actively remove them.  Admittedly, there are lots of instances of `--
> in the docs too, so making sure which way is "right" and then
> replacing _all_ of them would probably be a nice cleanup.

I'm not fully sure of the current situation, but if it, for instance, turns out that "--" gives an em-dash and "\--" gives two hyphens in a row, we'd only want to change the "--"'s to "\--" for things like command-line options, where an em-dash is totally inappropriate. If it's a sentence that is actually using an em-dash for another purpose, it is probably intentional and desirable to actually get an em-dash.

Obviously we want consistency, but--as this sentence shows--there is a difference between an em-dash and a command-line option like --version.