Re: [PATCH] doc/SubmittingPatches: improve text formatting

From: Junio C Hamano <gitster@pobox.com>
Date: Jan 4, 2018, 19:00 UTC
Message-ID: <xmqqa7xtfnzx.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <20180103235625.GB817655@genre.crustytoothpaste.net>

"brian m. carlson" <sandals@crustytoothpaste.net> writes:

Show 21 quoted lines

> On Tue, Jan 02, 2018 at 10:33:50AM -0500, Todd Zullinger wrote:
>> 049e64aa50 ("Documentation: convert SubmittingPatches to AsciiDoc",
>> 2017-11-12) changed the `git blame` and `git shortlog` examples given in
>> the section on sending your patches.
>> 
>> In order to italicize the `$path` argument the commands are enclosed in
>> plus characters as opposed to backticks.  The difference between the
>> quoting methods is that backtick enclosed text is not subject to further
>> expansion.  This formatting makes reading SubmittingPatches in a git
>> clone a little more difficult.  In addition to the underscores around
>> `$path` the `--` chars in `git shortlog --no-merges` must be replaced
>> with `{litdd}`.
>> 
>> Use backticks to quote these commands.  The italicized `$path` is lost
>> from the html version but the commands can be read (and copied) more
>> easily by users reading the text version.  These readers are more likely
>> to use the commands while submitting patches.  Make it easier for them.
>
> I think this change is fine.  I don't have a strong opinion either way
> and if others think the change makes the plain text more readable, I'm
> all for it.

I too would prefer to move towards plain text that reads easier, especially if it does not make the resulting typeset version unreadable; thanks, both.