From: Derrick Stolee <stolee@gmail.com>
To: "Junio C Hamano" <gitster@pobox.com>,
"阿德烈 via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, 阿德烈 <adlternative@gmail.com>
Subject: Re: Re* [PATCH] builtin/*: update usage format
Date: Wed, 6 Jan 2021 07:03:05 -0500 [thread overview]
Message-ID: <b6c68abd-e6b7-acec-6b1f-f915fe20e2e1@gmail.com> (raw)
In-Reply-To: <xmqqwnwqtuj1.fsf@gitster.c.googlers.com>
On 1/6/2021 2:05 AM, Junio C Hamano wrote:
> Subject: parse-options: format argh like error messages
>
> "Keep it homogeneous across the repository" is in general a
> guideline that can be used to converge to a good practice, but
> we can be a bit more prescriptive in this case. Just like the
> messages we give die(_("...")) are formatted without the final
> full stop and without the initial capitalization, most of the
> argument help text are already formatted that way, and we want
> to encourage that as the house style.
It's tough to "keep it homogeneous" when the repository isn't
already in that state. Thanks, ZheNing, for working to improve
that situation.
> * `argh`::
> - * token to explain the kind of argument this option wants. Keep it
> - * homogeneous across the repository. Should be wrapped by N_() for
> - * translation.
> + * token to explain the kind of argument this option wants. Does not
> + * begin in capital letter, and does not end with a full stop.
> + * Should be wrapped by N_() for translation.
I think this more-specific language is helpful.
Thanks,
-Stolee
next prev parent reply other threads:[~2021-01-06 12:03 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-29 8:55 [PATCH] builtin/*: update usage format 阿德烈 via GitGitGadget
2020-12-29 14:33 ` Felipe Contreras
2021-01-06 7:05 ` Re* " Junio C Hamano
2021-01-06 12:03 ` Derrick Stolee [this message]
2021-01-06 11:51 ` [PATCH v2 0/2] " 阿德烈 via GitGitGadget
2021-01-06 11:51 ` [PATCH v2 1/2] " ZheNing Hu via GitGitGadget
2021-01-06 11:51 ` [PATCH v2 2/2] parse-options: format argh like error messages Junio C Hamano via GitGitGadget
2021-01-06 12:05 ` Derrick Stolee
2021-01-06 14:44 ` [PATCH v3 0/2] builtin/*: update usage format 阿德烈 via GitGitGadget
2021-01-06 14:44 ` [PATCH v3 1/2] parse-options: format argh like error messages Junio C Hamano via GitGitGadget
2021-01-06 14:44 ` [PATCH v3 2/2] builtin/*: update usage format ZheNing Hu via GitGitGadget
2021-01-06 23:14 ` [PATCH v3 0/2] " Junio C Hamano
-- strict thread matches above, loose matches on Subject: below --
2021-01-06 11:07 Re* [PATCH] " 胡哲宁
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:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b6c68abd-e6b7-acec-6b1f-f915fe20e2e1@gmail.com \
--to=stolee@gmail.com \
--cc=adlternative@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* 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).