From e7188bcead99c74207b61d4f1e05f061c843c423 Mon Sep 17 00:00:00 2001 From: Luna Date: Wed, 17 Aug 2022 17:17:55 -0400 Subject: fix: docstrings --- bot/exts/moderation/infraction/_scheduler.py | 13 +++++++------ 1 file 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. -- cgit v1.2.3