From 2a464a190e2b55655597bf9e401609a8040c7d5c Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Fri, 26 Jul 2024 11:03:05 -0700 Subject: [PATCH] Improve wording in our help Make things a bit easier to read Signed-off-by: Tim Smith --- apps/cnquery/cmd/run.go | 2 +- apps/cnquery/cmd/shell.go | 2 +- providers/gitlab/config/config.go | 6 +++--- test/commands/testdata/cnquery_run.ct | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/apps/cnquery/cmd/run.go b/apps/cnquery/cmd/run.go index b409d7f676..8181db23fc 100644 --- a/apps/cnquery/cmd/run.go +++ b/apps/cnquery/cmd/run.go @@ -19,7 +19,7 @@ import ( func init() { rootCmd.AddCommand(RunCmd) - RunCmd.Flags().StringP("command", "c", "", "MQL query to executed in the shell") + RunCmd.Flags().StringP("command", "c", "", "MQL query to execute in the shell") RunCmd.Flags().Bool("parse", false, "Parse the query and return the logical structure") RunCmd.Flags().Bool("ast", false, "Parse the query and return the abstract syntax tree (AST)") RunCmd.Flags().Bool("info", false, "Parse the query and provide information about it") diff --git a/apps/cnquery/cmd/shell.go b/apps/cnquery/cmd/shell.go index 0adb502ee8..a9d6f63dc8 100644 --- a/apps/cnquery/cmd/shell.go +++ b/apps/cnquery/cmd/shell.go @@ -27,7 +27,7 @@ import ( func init() { rootCmd.AddCommand(shellCmd) - shellCmd.Flags().StringP("command", "c", "", "MQL query to executed in the shell") + shellCmd.Flags().StringP("command", "c", "", "MQL query to execute in the shell") shellCmd.Flags().String("platform-id", "", "Select a specific target asset by providing its platform ID") shellCmd.Flags().StringToString("annotations", nil, "Specify annotations for this run") _ = shellCmd.Flags().MarkHidden("annotations") diff --git a/providers/gitlab/config/config.go b/providers/gitlab/config/config.go index 462958fc85..069a90ed0e 100644 --- a/providers/gitlab/config/config.go +++ b/providers/gitlab/config/config.go @@ -40,19 +40,19 @@ var Config = plugin.Provider{ Type: plugin.FlagType_String, Option: plugin.FlagOption_Required, Default: "", - Desc: "a GitLab group to scan", + Desc: "GitLab group to scan", }, { Long: "project", Type: plugin.FlagType_String, Default: "", - Desc: "a GitLab project to scan", + Desc: "GitLab project to scan", }, { Long: "url", Type: plugin.FlagType_String, Default: "", - Desc: "custom GitLab base url", + Desc: "Custom GitLab base url", }, }, }, diff --git a/test/commands/testdata/cnquery_run.ct b/test/commands/testdata/cnquery_run.ct index 688efdf58f..d3d7b96259 100644 --- a/test/commands/testdata/cnquery_run.ct +++ b/test/commands/testdata/cnquery_run.ct @@ -11,7 +11,7 @@ Available Commands: Flags: --ast Parse the query and return the abstract syntax tree (AST) - -c, --command string MQL query to executed in the shell + -c, --command string MQL query to execute in the shell -h, --help help for run --info Parse the query and provide information about it -j, --json Run the query and return the object in a JSON structure