Skip to content

Commit 4ca7994

Browse files
committed
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. Noticed-by: ZheNing Hu <[email protected]> Signed-off-by: Junio C Hamano <[email protected]> Signed-off-by: ZheNing Hu <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 71ca53e commit 4ca7994

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

parse-options.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
8282
* stores pointers to the values to be filled.
8383
*
8484
* `argh`::
85-
* token to explain the kind of argument this option wants. Keep it
86-
* homogeneous across the repository. Should be wrapped by N_() for
87-
* translation.
85+
* token to explain the kind of argument this option wants. Does not
86+
* begin in capital letter, and does not end with a full stop.
87+
* Should be wrapped by N_() for translation.
8888
*
8989
* `help`::
9090
* the short help associated to what the option does.

0 commit comments

Comments
 (0)