archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <>
To: Bagas Sanjaya <>
Cc: Chinmoy via GitGitGadget <>,
	Chinmoy <>,
Subject: Re: [PATCH] Documentation: amended usages of various (sub)commands
Date: Sun, 28 Mar 2021 11:32:42 -0700	[thread overview]
Message-ID: <xmqq35wfm8mt.fsf@gitster.g> (raw)
In-Reply-To: <> (Bagas Sanjaya's message of "Sun, 28 Mar 2021 15:13:54 +0700")

Bagas Sanjaya <> writes:

>>> ...
>> 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.

  parent reply	other threads:[~2021-03-28 18:33 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-28  6:34 [PATCH] Documentation: amended usages of various (sub)commands Chinmoy via GitGitGadget
2021-03-28  6:56 ` Bagas Sanjaya
2021-03-28  8:13   ` Bagas Sanjaya
2021-03-28  8:24     ` Chinmoy Chakraborty
2021-03-28 18:32     ` Junio C Hamano [this message]
2021-03-29  5:17       ` Bagas Sanjaya
2021-03-28 10:16 ` [PATCH v2] Documentation: make (sub)command options conform to TD of option parsing Chinmoy via GitGitGadget
2021-03-29 10:45   ` [PATCH v3] column, range-diff: downcase option description Chinmoy via GitGitGadget
2021-03-29 10:58     ` Bagas Sanjaya
2021-03-29 13:46     ` Philip Oakley
2021-03-29 14:46     ` [PATCH v4] " Chinmoy via GitGitGadget
2021-03-29 21:05       ` Junio C Hamano

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:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqq35wfm8mt.fsf@gitster.g \ \ \ \ \ \

* 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).