From 5fa788d6e5151fc29ce9b60b2c12d937a0a76d83 Mon Sep 17 00:00:00 2001 From: Andreas Neumann Date: Tue, 25 Aug 2020 15:17:30 +0200 Subject: [PATCH] Small fixes in command descriptions Signed-off-by: Andreas Neumann --- pkg/kudoctl/cmd/package_verify.go | 2 +- pkg/kudoctl/cmd/plan.go | 4 ++-- pkg/kudoctl/cmd/update.go | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/pkg/kudoctl/cmd/package_verify.go b/pkg/kudoctl/cmd/package_verify.go index 3b4394608..4483dbea2 100644 --- a/pkg/kudoctl/cmd/package_verify.go +++ b/pkg/kudoctl/cmd/package_verify.go @@ -25,7 +25,7 @@ func newPackageVerifyCmd(fs afero.Fs, out io.Writer) *cobra.Command { cmd := &cobra.Command{ Use: "verify [package]", - Short: "verify package parameters", + Short: "verify KUDO package", Example: " kubectl kudo package verify ../zk/operator", RunE: func(cmd *cobra.Command, args []string) error { if err := validateOperatorArg(args); err != nil { diff --git a/pkg/kudoctl/cmd/plan.go b/pkg/kudoctl/cmd/plan.go index 9e104d8a7..ebdacd3fd 100644 --- a/pkg/kudoctl/cmd/plan.go +++ b/pkg/kudoctl/cmd/plan.go @@ -12,7 +12,7 @@ import ( const ( planHistoryExample = ` # View plan history - kubectl kudo plan history --instance= + kubectl kudo plan history --instance= ` planStatusExample = ` # View plan status kubectl kudo plan status --instance= @@ -42,7 +42,7 @@ func NewPlanHistoryCmd() *cobra.Command { options := plan.DefaultHistoryOptions cmd := &cobra.Command{ Use: "history", - Short: "Lists history to a specific operator-version of an instance.", + Short: "Lists history for each plan of an instance.", Example: planHistoryExample, RunE: func(cmd *cobra.Command, args []string) error { return plan.RunHistory(cmd, options, &Settings) diff --git a/pkg/kudoctl/cmd/update.go b/pkg/kudoctl/cmd/update.go index bcd206443..b1095f9fb 100644 --- a/pkg/kudoctl/cmd/update.go +++ b/pkg/kudoctl/cmd/update.go @@ -14,7 +14,7 @@ import ( ) var ( - updateDesc = `Update KUDO operator instance with new arguments. The update does not accept any arguments. + updateDesc = `Update KUDO operator instance with new parameters. The update of parameters can trigger the execution of specific plans. ` updateExample = ` # Update dev-flink instance with setting parameter param with value value kubectl kudo update --instance dev-flink -p param=value