All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Chinmoy via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Bagas Sanjaya <bagasdotme@gmail.com>,
	Chinmoy <chinmoy12c@gmail.com>,
	Chinmoy Chakraborty <chinmoy12c@gmail.com>
Subject: [PATCH v3] column, range-diff: downcase option description
Date: Mon, 29 Mar 2021 10:45:52 +0000	[thread overview]
Message-ID: <pull.920.v3.git.1617014753305.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.920.v2.git.1616926582735.gitgitgadget@gmail.com>

From: Chinmoy Chakraborty <chinmoy12c@gmail.com>

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@gmail.com>
---
    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@gmail.com

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@gmail.com>
      
       ## 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@gmail.com>
      


 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
-- 
gitgitgadget

  reply	other threads:[~2021-03-29 10:46 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-28  6:34 [PATCH] Documentation: amended usages of various (sub)commands Chinmoy via GitGitGadget
2021-03-28  6:56 ` Bagas Sanjaya
2021-03-28  8:13   ` Bagas Sanjaya
2021-03-28  8:24     ` Chinmoy Chakraborty
2021-03-28 18:32     ` Junio C Hamano
2021-03-29  5:17       ` Bagas Sanjaya
2021-03-28 10:16 ` [PATCH v2] Documentation: make (sub)command options conform to TD of option parsing Chinmoy via GitGitGadget
2021-03-29 10:45   ` Chinmoy via GitGitGadget [this message]
2021-03-29 10:58     ` [PATCH v3] column, range-diff: downcase option description Bagas Sanjaya
2021-03-29 13:46     ` Philip Oakley
2021-03-29 14:46     ` [PATCH v4] " Chinmoy via GitGitGadget
2021-03-29 21:05       ` Junio C Hamano

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

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

  git send-email \
    --in-reply-to=pull.920.v3.git.1617014753305.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail.com \
    --cc=bagasdotme@gmail.com \
    --cc=chinmoy12c@gmail.com \
    --cc=git@vger.kernel.org \
    /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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.