Re: [PATCH 2/6] doc: line-range: improve formatting
Show 17 quoted lines
> Le 29 oct. 2020 à 16:19, Junio C Hamano <gitster@pobox.com> a écrit :
>
> Eric Sunshine <sunshine@sunshineco.com> writes:
>
>> On Wed, Oct 28, 2020 at 8:48 AM Philippe Blain via GitGitGadget
>> <gitgitgadget@gmail.com> wrote:
>>> Improve the formatting of the description of the line-range option '-L'
>>> for `git log`, `gitk` and `git blame`:
>>>
>>> - Use bold for <start>, <end> and <funcname>
>>
>> My impression is that it is more common in Git documentation for these
>> placeholders to be formatted with backticks rather than as bold (or,
>> if not more common currently, at least is trending that way). That's
>> not to say that my impression is necessarily accurate.
>
> I think the impression is fairly in line with the reality.
Yes, I compared using
git grep '`<' | wc -l
and
git grep "'<" | wc -l
and the same for their closing counterparts and the backticks win.
Show 8 quoted lines
> That is
> not to say that it is a good future to aim for.
>
> My personal preference is
>
> - use `as-is` for things that must be typed as-is (e.g. `-L`)
>
> - use 'emph' for things that are placeholder (e.g. '<start>'').
Thanks for clarifying. It is indeed what I tried to do.
Philippe Blain <levraiphilippeblain@gmail.com>