diff mbox series

[v2,2/2] parse-options: format argh like error messages

Message ID c5f01b0eab1dd13d46ac344e362cd13e7bc365fc.1609933875.git.gitgitgadget@gmail.com (mailing list archive)
State Accepted
Commit 4ca7994b2a037e98fd3205bb915904f245c9461e
Headers show
Series builtin/*: update usage format | expand

Commit Message

Junio C Hamano Jan. 6, 2021, 11:51 a.m. UTC 
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(-)

Comments

Derrick Stolee Jan. 6, 2021, 12:05 p.m. UTC | #1 
On 1/6/2021 6:51 AM, Junio C Hamano via GitGitGadget wrote:
> 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>

ZheNing,

It is certainly a common thing to pull patches from other
contributors into your own series. However, you'll need to
add your own sign-off at the end.

I also believe that the intention was that this patch
would come before the other, so please swap the patches.
Then, you can update the message in the other patch from

  According to the "Error Messages" section of
  Documentation/CodingGuidelines,

to 

  According to the guidelines in parse-options.h,

Thanks,
-Stolee
diff mbox series

Patch

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.