Skip to content

Commit c5222b5

Browse files
authored
fix: disable/enable tenant command docs (#448)
1 parent 8355ba7 commit c5222b5

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

pkg/cmd/tenant/disable/disable.go

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,13 @@ func NewDisableOptions(args []string, dependencies *cmd.Dependencies) *DisableOp
2525

2626
func NewCmdDisable(f factory.Factory) *cobra.Command {
2727
cmd := &cobra.Command{
28-
Use: "disable",
29-
Short: "Disable a tenant",
30-
Long: "Disable a tenant in Octopus Deploy",
31-
Example: heredoc.Docf("$ %[1]s tenant enable", constants.ExecutableName),
28+
Use: "disable {<name> | <id>}",
29+
Short: "Disable a tenant",
30+
Long: "Disable a tenant in Octopus Deploy",
31+
Example: heredoc.Docf(`
32+
$ %[1]s disable view Tenants-1
33+
$ %[1]s disable view 'Tenant'
34+
`, constants.ExecutableName),
3235
RunE: func(c *cobra.Command, args []string) error {
3336
if len(args) == 0 {
3437
args = append(args, "")

pkg/cmd/tenant/enable/enable.go

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,13 @@ func NewEnableOptions(args []string, dependencies *cmd.Dependencies) *EnableOpti
2525

2626
func NewCmdEnable(f factory.Factory) *cobra.Command {
2727
cmd := &cobra.Command{
28-
Use: "enable",
29-
Short: "Enable a tenant",
30-
Long: "Enable a tenant in Octopus Deploy",
31-
Example: heredoc.Docf("$ %[1]s tenant enable", constants.ExecutableName),
28+
Use: "enable {<name> | <id>}",
29+
Short: "Enable a tenant",
30+
Long: "Enable a tenant in Octopus Deploy",
31+
Example: heredoc.Docf(`
32+
$ %[1]s tenant enable Tenants-1
33+
$ %[1]s tenant enable 'Tenant'
34+
`, constants.ExecutableName),
3235
RunE: func(c *cobra.Command, args []string) error {
3336
if len(args) == 0 {
3437
args = append(args, "")

0 commit comments

Comments
 (0)