diff options
| author | 2022-08-17 17:19:51 -0400 | |
|---|---|---|
| committer | 2022-08-17 17:19:51 -0400 | |
| commit | b8d4de5ae93740686146649afe6ae807ac83dd8b (patch) | |
| tree | c013913780d3ccf8eb74c4e5156c619888c8b1f1 | |
| parent | Merge pull request #1 from VirdanTheBurden/feat-add-reason-argument-to-pardons (diff) | |
| parent | fix: docstrings (diff) | |
Merge pull request #2 from VirdanTheBurden/feat-add-reason-argument-to-pardons
fix: docstrings
| -rw-r--r-- | bot/exts/moderation/infraction/_scheduler.py | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/bot/exts/moderation/infraction/_scheduler.py b/bot/exts/moderation/infraction/_scheduler.py index a6846e239..b0a2e3359 100644 --- a/bot/exts/moderation/infraction/_scheduler.py +++ b/bot/exts/moderation/infraction/_scheduler.py @@ -279,7 +279,7 @@ class InfractionScheduler: """ Prematurely end an infraction for a user and log the action in the mod log. - If `pardon_reason` is None, then the infraction object will not receive + If `pardon_reason` is None, then the database will not receive appended text explaining why the infraction was pardoned. If `send_msg` is True, then a pardoning confirmation message will be sent to @@ -367,12 +367,13 @@ class InfractionScheduler: """ Deactivate an active infraction and return a dictionary of lines to send in a mod log. - If `pardon_reason` is None, then the infraction object will not receive - appended text explaining why the infraction was pardoned. - The infraction is removed from Discord, marked as inactive in the database, and has its - expiration task cancelled. If `send_log` is True, a mod log is sent for the - deactivation of the infraction. + expiration task cancelled. + + If `pardon_reason` is None, then the database will not receive + appended text explaining why the infraction was pardoned. + + If `send_log` is True, a mod log is sent for the deactivation of the infraction. If `notify` is True, notify the user of the pardon via DM where applicable. |