Super minor nit - missing space after full stop. On 29/03/2021 11:45, Chinmoy via GitGitGadget wrote: > From: Chinmoy Chakraborty <chinmoy12c@xxxxxxxxx> > > It is customary not to begin the help text for each option given to > the parse-options API with a capital letter.Various (sub)commands' s/Various/ Various/ -- Philip > option arrays don't follow the guideline provided by the parse_options > Documentation regarding the descriptions. > > Downcase the first word of some option descriptions for "column" > and "range-diff". > > Signed-off-by: Chinmoy Chakraborty <chinmoy12c@xxxxxxxxx> > --- > column, range-diff: downcase option description > > It is customary not to begin the help text for each option given to the > parse-options API with a capital letter.Various (sub)commands' option > arrays don't follow the guideline provided by the parse_options > Documentation regarding the descriptions. > > Downcase the first word of some option descriptions for "column" and > "range-diff". > > Signed-off-by: Chinmoy Chakraborty chinmoy12c@xxxxxxxxx > > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-920%2Fchinmoy12c%2Fissue_636-v3 > Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-920/chinmoy12c/issue_636-v3 > Pull-Request: https://github.com/gitgitgadget/git/pull/920 > > Range-diff vs v2: > > 1: b032c2fa5b28 ! 1: 61be08b7dd73 Documentation: make (sub)command options conform to TD of option parsing > @@ Metadata > Author: Chinmoy Chakraborty <chinmoy12c@xxxxxxxxx> > > ## Commit message ## > - Documentation: make (sub)command options conform to TD of option parsing > + column, range-diff: downcase option description > > - The Git suite option parsing API's Technical Documentation suggests this > - about the option descriptions of a (sub)command: > + It is customary not to begin the help text for each option given to > + the parse-options API with a capital letter.Various (sub)commands' > + option arrays don't follow the guideline provided by the parse_options > + Documentation regarding the descriptions. > > - `description` is a short string to describe the effect of the option. > - It shall begin with a lower-case letter and a full stop (.) shall be > - omitted at the end. > - > - Various (sub)commands' option arrays don't follow the guideline provided > - by the parse_options Documentation regarding the descriptions. > + Downcase the first word of some option descriptions for "column" > + and "range-diff". > > Signed-off-by: Chinmoy Chakraborty <chinmoy12c@xxxxxxxxx> > > > > builtin/column.c | 8 ++++---- > builtin/range-diff.c | 2 +- > 2 files changed, 5 insertions(+), 5 deletions(-) > > diff --git a/builtin/column.c b/builtin/column.c > index e815e148aa18..40d4b3bee2dd 100644 > --- a/builtin/column.c > +++ b/builtin/column.c > @@ -27,10 +27,10 @@ int cmd_column(int argc, const char **argv, const char *prefix) > OPT_STRING(0, "command", &real_command, N_("name"), N_("lookup config vars")), > OPT_COLUMN(0, "mode", &colopts, N_("layout to use")), > OPT_INTEGER(0, "raw-mode", &colopts, N_("layout to use")), > - OPT_INTEGER(0, "width", &copts.width, N_("Maximum width")), > - OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("Padding space on left border")), > - OPT_INTEGER(0, "nl", &copts.nl, N_("Padding space on right border")), > - OPT_INTEGER(0, "padding", &copts.padding, N_("Padding space between columns")), > + OPT_INTEGER(0, "width", &copts.width, N_("maximum width")), > + OPT_STRING(0, "indent", &copts.indent, N_("string"), N_("padding space on left border")), > + OPT_INTEGER(0, "nl", &copts.nl, N_("padding space on right border")), > + OPT_INTEGER(0, "padding", &copts.padding, N_("padding space between columns")), > OPT_END() > }; > > diff --git a/builtin/range-diff.c b/builtin/range-diff.c > index 78bc9fa77062..50318849d657 100644 > --- a/builtin/range-diff.c > +++ b/builtin/range-diff.c > @@ -25,7 +25,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) > struct option range_diff_options[] = { > OPT_INTEGER(0, "creation-factor", > &range_diff_opts.creation_factor, > - N_("Percentage by which creation is weighted")), > + N_("percentage by which creation is weighted")), > OPT_BOOL(0, "no-dual-color", &simple_color, > N_("use simple diff colors")), > OPT_PASSTHRU_ARGV(0, "notes", &other_arg, > > base-commit: 84d06cdc06389ae7c462434cb7b1db0980f63860
