From aaf411fc183f090130303c0ca7ba7ce14b84cd5b Mon Sep 17 00:00:00 2001 From: Leonardo Grasso Date: Wed, 26 Feb 2025 17:50:46 +0100 Subject: [PATCH] docs(cmd): improve `suite` command description Signed-off-by: Leonardo Grasso --- cmd/suite/config/doc.go | 2 +- cmd/suite/suite.go | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cmd/suite/config/doc.go b/cmd/suite/config/doc.go index 59866554..2ba212ab 100644 --- a/cmd/suite/config/doc.go +++ b/cmd/suite/config/doc.go @@ -13,6 +13,6 @@ // See the License for the specific language governing permissions and // limitations under the License. -// Package config provides the implementation of Config, the configuration shared among suite commands. Among other +// Package config provides the implementation of Config, the configuration shared among suite-related commands. Among other // shared settings, it also stores the values of the shared flags. package config diff --git a/cmd/suite/suite.go b/cmd/suite/suite.go index 141c1e96..e97a4370 100644 --- a/cmd/suite/suite.go +++ b/cmd/suite/suite.go @@ -28,8 +28,8 @@ import ( func New(suiteEnvKey, envKeysPrefix string) *cobra.Command { c := &cobra.Command{ Use: "suite", - Short: "Manage everything related to test suites", - Long: "Manage everything related to test suites", + Short: "Manage test suites described via YAML files", + Long: "Provide sub-commands to work with test suites described via YAML files", DisableAutoGenTag: true, }