From c5222b5bc1175407a62992958e571a58e7247fba Mon Sep 17 00:00:00 2001 From: grace-rehn Date: Wed, 20 Nov 2024 14:38:29 +1000 Subject: [PATCH] fix: disable/enable tenant command docs (#448) --- pkg/cmd/tenant/disable/disable.go | 11 +++++++---- pkg/cmd/tenant/enable/enable.go | 11 +++++++---- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/pkg/cmd/tenant/disable/disable.go b/pkg/cmd/tenant/disable/disable.go index d670cb67..a36b007e 100644 --- a/pkg/cmd/tenant/disable/disable.go +++ b/pkg/cmd/tenant/disable/disable.go @@ -25,10 +25,13 @@ func NewDisableOptions(args []string, dependencies *cmd.Dependencies) *DisableOp func NewCmdDisable(f factory.Factory) *cobra.Command { cmd := &cobra.Command{ - Use: "disable", - Short: "Disable a tenant", - Long: "Disable a tenant in Octopus Deploy", - Example: heredoc.Docf("$ %[1]s tenant enable", constants.ExecutableName), + Use: "disable { | }", + Short: "Disable a tenant", + Long: "Disable a tenant in Octopus Deploy", + Example: heredoc.Docf(` + $ %[1]s disable view Tenants-1 + $ %[1]s disable view 'Tenant' + `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { if len(args) == 0 { args = append(args, "") diff --git a/pkg/cmd/tenant/enable/enable.go b/pkg/cmd/tenant/enable/enable.go index 6bc6e661..5070c9ea 100644 --- a/pkg/cmd/tenant/enable/enable.go +++ b/pkg/cmd/tenant/enable/enable.go @@ -25,10 +25,13 @@ func NewEnableOptions(args []string, dependencies *cmd.Dependencies) *EnableOpti func NewCmdEnable(f factory.Factory) *cobra.Command { cmd := &cobra.Command{ - Use: "enable", - Short: "Enable a tenant", - Long: "Enable a tenant in Octopus Deploy", - Example: heredoc.Docf("$ %[1]s tenant enable", constants.ExecutableName), + Use: "enable { | }", + Short: "Enable a tenant", + Long: "Enable a tenant in Octopus Deploy", + Example: heredoc.Docf(` + $ %[1]s tenant enable Tenants-1 + $ %[1]s tenant enable 'Tenant' + `, constants.ExecutableName), RunE: func(c *cobra.Command, args []string) error { if len(args) == 0 { args = append(args, "")