CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update Mutes docs with timeout changes (#6341)

Browse Source
This commit is contained in:
Jakub Kuczys 2024-04-01 03:00:53 +02:00 committed by GitHub
parent 59400204e8
commit 194dea545d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 35 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/cog_guides/mutes.rst
View File

@ -145,28 +145,6 @@ If no time interval is provided this will be cleared.
* ``[time]``: The length of time for a default mute. * ``[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: .. _mutes-command-muteset-makerole:
"""""""""""""""" """"""""""""""""
@ -238,8 +216,8 @@ muteset role
Sets the role to be applied when muting a user. 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 If no role is setup the bot will attempt to mute a user
channel overwrites in all channels to prevent the user from sending messages. by utilizing server timeouts.
.. Note:: .. Note::
@ -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. * ``<users...>``: A space separated list of usernames, ID's, or mentions.
* ``[reason]``: The reason for the unmute. * ``[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: .. _mutes-command-voicemute:
^^^^^^^^^ ^^^^^^^^^
@ -372,7 +378,7 @@ voicemute
.. code-block:: none .. code-block:: none
[p]voicemute <users...> [reason] [p]voicemute <users...> [time_and_reason]
**Description** **Description**

8
redbot/cogs/mutes/mutes.py
View File

@ -1127,13 +1127,13 @@ class Mutes(VoiceMutes, commands.Cog, metaclass=CompositeMetaClass):
"""Timeout users. """Timeout users.
`<users...>` is a space separated list of usernames, ID's, or mentions. `<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 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: Examples:
`[p]mute @member1 @member2 spam 5 hours` `[p]timeout @member1 @member2 spam 5 hours`
`[p]mute @member1 3 days` `[p]timeout @member1 3 days`
""" """
if not users: if not users: