parse-options: format argh like error messages

gitster · gitster · commit 4ca7994b2a03 · 2021-01-06T15:10:27.000-08:00
"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 &lt;adlternative@gmail.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
Signed-off-by: ZheNing Hu &lt;adlternative@gmail.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git 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.

Original file line number	Diff line number	Diff line change
`@@ -82,9 +82,9 @@ typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,`
`82`	`82`	`* stores pointers to the values to be filled.`
`83`	`83`	`*`
`84`	`84`	* `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.`
`88`	`88`	`*`
`89`	`89`	* `help`::
`90`	`90`	`* the short help associated to what the option does.`