Skip to content

Commit

Permalink
[MM-61132] Fix example for mmctl permissions role show command (matte…
Browse files Browse the repository at this point in the history
  • Loading branch information
hanzei authored Oct 24, 2024
1 parent ebb0178 commit 707144d
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
16 changes: 8 additions & 8 deletions server/cmd/mmctl/commands/channel.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ var RemoveChannelUsersCmd = &cobra.Command{
Long: "Remove some users from channel",
Example: ` channel remove myteam:mychannel [email protected] username
channel remove myteam:mychannel --all-users`,
Deprecated: "please use \"users remove\" instead",
Deprecated: "please use \"mmctl channel users remove\" instead",
RunE: withClient(channelUsersRemoveCmdF),
}

Expand All @@ -60,7 +60,7 @@ var AddChannelUsersCmd = &cobra.Command{
Short: "Add users to channel",
Long: "Add some users to channel",
Example: " channel add myteam:mychannel [email protected] username",
Deprecated: "please use \"users add\" instead",
Deprecated: "please use \"mmctl channel users add\" instead",
RunE: withClient(channelUsersAddCmdF),
}

Expand Down Expand Up @@ -108,13 +108,13 @@ Channel can be specified by [team]:[channel]. ie. myteam:mychannel or by channel
}

var RestoreChannelsCmd = &cobra.Command{
Use: "restore [channels]",
Deprecated: "please use \"unarchive\" instead",
Short: "Restore some channels",
Use: "restore [channels]",
Short: "Restore some channels",
Long: `Restore a previously deleted channel
Channels can be specified by [team]:[channel]. ie. myteam:mychannel or by channel ID.`,
Example: " channel restore myteam:mychannel",
RunE: withClient(unarchiveChannelsCmdF),
Example: " channel restore myteam:mychannel",
Deprecated: "please use \"mmctl channel unarchive\" instead",
RunE: withClient(unarchiveChannelsCmdF),
}

var UnarchiveChannelCmd = &cobra.Command{
Expand All @@ -133,7 +133,7 @@ var MakeChannelPrivateCmd = &cobra.Command{
Long: `Set the type of a channel from Public to Private.
Channel can be specified by [team]:[channel]. ie. myteam:mychannel or by channel ID.`,
Example: " channel make-private myteam:mychannel",
Deprecated: "please use \"channel modify --private\" instead",
Deprecated: "please use \"mmctl channel modify --private\" instead",
RunE: withClient(makeChannelPrivateCmdF),
}

Expand Down
2 changes: 1 addition & 1 deletion server/cmd/mmctl/commands/command.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ var CommandDeleteCmd = &cobra.Command{
Short: "Delete a slash command",
Long: `Delete a slash command. Commands can be specified by command ID.`,
Example: ` command delete commandID`,
Deprecated: "please use \"archive\" instead",
Deprecated: "please use \"mmctl channel archive\" instead",
Args: cobra.ExactArgs(1),
RunE: withClient(archiveCommandCmdF),
}
Expand Down
2 changes: 1 addition & 1 deletion server/cmd/mmctl/commands/permissions.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var RemovePermissionsCmd = &cobra.Command{

var ShowRoleCmd = &cobra.Command{
Use: "show <role_name>",
Deprecated: "please use \"role show\" instead",
Deprecated: "please use \"mmctl permissions role show\" instead",
Short: "Show the role information",
Long: "Show all the information about a role.",
Example: ` permissions show system_user`,
Expand Down
2 changes: 1 addition & 1 deletion server/cmd/mmctl/commands/permissions_role.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ var ShowCmd = &cobra.Command{
Use: "show <role_name>",
Short: "Show the role information",
Long: "Show all the information about a role.",
Example: ` permissions show system_user`,
Example: ` permissions role show system_user`,
Args: cobra.ExactArgs(1),
RunE: withClient(showRoleCmdF),
}
Expand Down
2 changes: 1 addition & 1 deletion server/cmd/mmctl/docs/mmctl_permissions_role_show.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Examples

::

permissions show system_user
permissions role show system_user

Options
~~~~~~~
Expand Down

0 comments on commit 707144d

Please sign in to comment.