Skip to content

Commit

Permalink
Update Mutes docs with timeout changes (#6341)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jackenmen authored Apr 1, 2024
1 parent 5940020 commit 194dea5
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 29 deletions.
56 changes: 31 additions & 25 deletions docs/cog_guides/mutes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <true_or_false>
**Description**

Whether or not to force role only mutes on the bot.

**Arguments**

* ``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.

.. _mutes-command-muteset-makerole:

""""""""""""""""
Expand Down Expand Up @@ -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::

Expand Down Expand Up @@ -362,6 +340,34 @@ Unmute a user in this channel (or in the parent of this thread).
* ``<users...>``: 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 <users...> [time_and_reason]
**Description**

Timeout users.

Examples:

* ``[p]timeout @member1 @member2 spam 5 hours``
* ``[p]timeout @member1 3 days``

**Arguments**

* ``<users...>``: 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:

^^^^^^^^^
Expand All @@ -372,7 +378,7 @@ voicemute

.. code-block:: none
[p]voicemute <users...> [reason]
[p]voicemute <users...> [time_and_reason]
**Description**

Expand Down
8 changes: 4 additions & 4 deletions redbot/cogs/mutes/mutes.py
Original file line number Diff line number Diff line change
Expand Up @@ -1127,13 +1127,13 @@ async def timeout(
"""Timeout users.
`<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:
Expand Down

0 comments on commit 194dea5

Please sign in to comment.