aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar ionite34 <[email protected]>2022-07-28 05:36:45 -0400
committerGravatar Ionite <[email protected]>2022-08-16 16:38:26 -0400
commit3e9ffa1ea3c7cfa7c583189fcb8675db9ee5c6d5 (patch)
tree4674af896ac2a7a1cd50fc9d3c453de84aed0b15
parentUpdated parameter names (diff)
Updated ban command docstring
- Updated docstring to be more explicit on parameter fields
-rw-r--r--bot/exts/moderation/infraction/infractions.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/bot/exts/moderation/infraction/infractions.py b/bot/exts/moderation/infraction/infractions.py
index 12bd084df..83a947a19 100644
--- a/bot/exts/moderation/infraction/infractions.py
+++ b/bot/exts/moderation/infraction/infractions.py
@@ -91,9 +91,11 @@ class Infractions(InfractionScheduler, commands.Cog):
reason: t.Optional[str] = None
) -> None:
"""
- Permanently ban a user for the given reason and stop watching them with Big Brother.
+ Permanently ban a `user` for the given `reason` and stop watching them with Big Brother.
- If duration is specified, it temporarily bans that user for the given duration.
+ If a duration is specified, it temporarily bans the `user` for the given duration.
+ Alternatively, an ISO 8601 timestamp representing the expiry time can be provided
+ for `duration_or_expiry`.
"""
await self.apply_ban(ctx, user, reason, duration_or_expiry=duration_or_expiry)