diff --git a/docs/cog_guides/mutes.rst b/docs/cog_guides/mutes.rst index cbab3fba5..48e311dc8 100644 --- a/docs/cog_guides/mutes.rst +++ b/docs/cog_guides/mutes.rst @@ -145,28 +145,6 @@ If no time interval is provided this will be cleared. * ``[time]``: The length of time for a default mute. -.. _mutes-command-muteset-forcerole: - -""""""""""""""""" -muteset forcerole -""""""""""""""""" - -.. note:: |owner-lock| - -**Syntax** - -.. code-block:: none - - [p]muteset forcerole - -**Description** - -Whether or not to force role only mutes on the bot. - -**Arguments** - -* ````: Whether to enable or disable this setting, must provide ``true`` or ``false``. - .. _mutes-command-muteset-makerole: """""""""""""""" @@ -238,8 +216,8 @@ muteset role Sets the role to be applied when muting a user. -If no role is setup the bot will attempt to mute a user by setting -channel overwrites in all channels to prevent the user from sending messages. +If no role is setup the bot will attempt to mute a user +by utilizing server timeouts. .. Note:: @@ -362,6 +340,34 @@ Unmute a user in this channel (or in the parent of this thread). * ````: A space separated list of usernames, ID's, or mentions. * ``[reason]``: The reason for the unmute. +.. _mutes-command-timeout: + +^^^^^^^ +timeout +^^^^^^^ + +.. note:: |mod-lock| + +**Syntax** + +.. code-block:: none + + [p]timeout [time_and_reason] + +**Description** + +Timeout users. + +Examples: + +* ``[p]timeout @member1 @member2 spam 5 hours`` +* ``[p]timeout @member1 3 days`` + +**Arguments** + +* ````: A space separated list of usernames, ID's, or mentions. +* ``[time_and_reason]``: The time and reason. If no time is provided, the mute will use the default set time or give an error if this hasn't been configured. + .. _mutes-command-voicemute: ^^^^^^^^^ @@ -372,7 +378,7 @@ voicemute .. code-block:: none - [p]voicemute [reason] + [p]voicemute [time_and_reason] **Description** diff --git a/redbot/cogs/mutes/mutes.py b/redbot/cogs/mutes/mutes.py index 77607cd15..edf65ee13 100644 --- a/redbot/cogs/mutes/mutes.py +++ b/redbot/cogs/mutes/mutes.py @@ -1127,13 +1127,13 @@ class Mutes(VoiceMutes, commands.Cog, metaclass=CompositeMetaClass): """Timeout users. `` is a space separated list of usernames, ID's, or mentions. - `[time_and_reason]` is the time to mute for and reason. Time is + `[time_and_reason]` is the time to timeout for and reason. Time is any valid time length such as `30 minutes` or `2 days`. If nothing - is provided the mute will use the set default time or indefinite if not set. + is provided the timeout will use the set default time or give an error if not set. Examples: - `[p]mute @member1 @member2 spam 5 hours` - `[p]mute @member1 3 days` + `[p]timeout @member1 @member2 spam 5 hours` + `[p]timeout @member1 3 days` """ if not users: