git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Junio C Hamano via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Felipe Contreras" <felipe.contreras@gmail.com>,
	阿德烈 <adlternative@gmail.com>,
	"Junio C Hamano" <gitster@pobox.com>
Subject: [PATCH v2 2/2] parse-options: format argh like error messages
Date: Wed, 06 Jan 2021 11:51:15 +0000	[thread overview]
Message-ID: <c5f01b0eab1dd13d46ac344e362cd13e7bc365fc.1609933875.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.822.v2.git.1609933875.gitgitgadget@gmail.com>

From: Junio C Hamano <gitster@pobox.com>

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

Noticed-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 parse-options.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/parse-options.h b/parse-options.h
index 7030d8f3da6..ff6506a5047 100644
--- a/parse-options.h
+++ b/parse-options.h
@@ -82,9 +82,9 @@ typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
  *   stores pointers to the values to be filled.
  *
  * `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.
  *
  * `help`::
  *   the short help associated to what the option does.
-- 
gitgitgadget

  parent reply	other threads:[~2021-01-06 11:53 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
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   ` Junio C Hamano via GitGitGadget [this message]
2021-01-06 12:05     ` [PATCH v2 2/2] parse-options: format argh like error messages 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 14:16 [PATCH v2 2/2] parse-options: format argh like error messages 胡哲宁

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

  List information: http://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to=c5f01b0eab1dd13d46ac344e362cd13e7bc365fc.1609933875.git.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail.com \
    --cc=adlternative@gmail.com \
    --cc=felipe.contreras@gmail.com \
    --cc=git@vger.kernel.org \
    --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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).