Re: [PATCH] Documentation: amended usages of various (sub)commands

Bagas Sanjaya [off-list ref] writes:

quoted

quoted

...

Wait, I expected that this patch touches Documentation/* (as the title implied),
but it seems like the patch content is something else (not related).
Totally wrong patch submitted here.

Please learn to trim your quotes.

Oops, I don't see that diff above. Sorry for that.

What about this patch title below?:

`Make (sub)command options conform to TD of option parsing`

"Make X conform" has low information contents (especially when
nobody knows what the TD is), because nobody would try to make the
code worse by making things nonconforming.

    Subject: [PATCH] column, range-diff: downcase option description

    It is customary not to begin the help text for each option given to
    the parse-options API with a capital letter.

    Downcase the first word of some option descriptions for "column"
    and "range-diff".

or something like that?

Even though the guideline for the documentation talks about two
things (i.e. not starting with capital and omitting full-stop at the
end), the help strings being touched by the patch only have problem
with the former, so quoting the guideline in full would not help
people understand what is changed and why.

On 29/03/21 01.32, Junio C Hamano wrote:

quoted

What about this patch title below?:

`Make (sub)command options conform to TD of option parsing`

"Make X conform" has low information contents (especially when
nobody knows what the TD is), because nobody would try to make the
code worse by making things nonconforming.

     Subject: [PATCH] column, range-diff: downcase option description

     It is customary not to begin the help text for each option given to
     the parse-options API with a capital letter.

     Downcase the first word of some option descriptions for "column"
     and "range-diff".

or something like that?

That's what this patch intended to do (from the diff).

-- 
An old man doll... just what I always wanted! - Clara