refactor: change start and end descriptions

issue: #7
bvieira · Jan 25, 2021 · 741962b · 741962b
1 parent 3652c52
commit 741962b
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/cmd/git-sv/main.go b/cmd/git-sv/main.go
@@ -43,25 +43,25 @@ func main() {
 			Name:        "commit-log",
 			Aliases:     []string{"cl"},
 			Usage:       "list all commit logs according to range as jsons",
-			Description: "when flag range is \"tag\" and start is empty, last tag created will be used instead",
+			Description: "The range filter is used based on git log filters, check https://git-scm.com/docs/git-log for more info. When flag range is \"tag\" and start is empty, last tag created will be used instead. When flag range is \"date\", if \"end\" is YYYY-MM-DD the range will be inclusive.",
 			Action:      commitLogHandler(git, semverProcessor),
 			Flags: []cli.Flag{
 				&cli.StringFlag{Name: "t", Aliases: []string{"tag"}, Usage: "get commit log from a specific tag"},
 				&cli.StringFlag{Name: "r", Aliases: []string{"range"}, Usage: "type of range of commits, use: tag, date or hash", Value: string(sv.TagRange)},
-				&cli.StringFlag{Name: "s", Aliases: []string{"start"}, Usage: "start range"},
-				&cli.StringFlag{Name: "e", Aliases: []string{"end"}, Usage: "end range"},
+				&cli.StringFlag{Name: "s", Aliases: []string{"start"}, Usage: "start range of git log revision range, if date, the value is used on since flag instead"},
+				&cli.StringFlag{Name: "e", Aliases: []string{"end"}, Usage: "end range of git log revision range, if date, the value is used on until flag instead"},
 			},
 		},
 		{
 			Name:        "commit-notes",
 			Aliases:     []string{"cn"},
 			Usage:       "generate a commit notes according to range",
-			Description: "when flag range is \"tag\" and start is empty, last tag created will be used instead",
+			Description: "The range filter is used based on git log filters, check https://git-scm.com/docs/git-log for more info. When flag range is \"tag\" and start is empty, last tag created will be used instead. When flag range is \"date\", if \"end\" is YYYY-MM-DD the range will be inclusive.",
 			Action:      commitNotesHandler(git, releasenotesProcessor, outputFormatter),
 			Flags: []cli.Flag{
 				&cli.StringFlag{Name: "r", Aliases: []string{"range"}, Usage: "type of range of commits, use: tag, date or hash", Required: true},
-				&cli.StringFlag{Name: "s", Aliases: []string{"start"}, Usage: "start range"},
-				&cli.StringFlag{Name: "e", Aliases: []string{"end"}, Usage: "end range"},
+				&cli.StringFlag{Name: "s", Aliases: []string{"start"}, Usage: "start range of git log revision range, if date, the value is used on since flag instead"},
+				&cli.StringFlag{Name: "e", Aliases: []string{"end"}, Usage: "end range of git log revision range, if date, the value is used on until flag instead"},
 			},
 		},
 		{