diff options
| author |  ionite34 <[email protected]> | 2022-07-28 05:36:45 -0400 |
|---|---|---|
| committer | ionite34 <[email protected]> | 2022-07-28 05:36:45 -0400 |
| commit | 517d3aad25c912a0f5ae47388a0d5a9deefe9d50 (patch) | |
| tree | 2cda4a2358ecf49cebda1285fac4ffde81f4dbb1 | |
| parent | Updated parameter names (diff) | |
Updated ban command docstring
- Updated docstring to be more explicit on parameter fields
| -rw-r--r-- | bot/exts/moderation/infraction/infractions.py | 6 |
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) |