Document relationship between AutoModRuleAction and its type

This commit is contained in:
Mikey 2022-08-03 00:13:00 -07:00 committed by GitHub
parent 2fb309a463
commit 5538cd501c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -65,11 +65,14 @@ class AutoModRuleAction:
-----------
type: :class:`AutoModRuleActionType`
The type of action to take.
Defaults to :attr:`~AutoModRuleActionType.block_message`.
channel_id: Optional[:class:`int`]
The ID of the channel or thread to send the alert message to, if any.
Passing this sets :attr:`type` to :attr:`~AutoModRuleActionType.send_alert_message`.
duration: Optional[:class:`datetime.timedelta`]
The duration of the timeout to apply, if any.
Has a maximum of 28 days.
Passing this sets :attr:`type` to :attr:`~AutoModRuleActionType.timeout`.
"""
__slots__ = ('type', 'channel_id', 'duration')