diff options
| author |  Chris <[email protected]> | 2021-03-30 20:48:37 +0100 |
|---|---|---|
| committer | Chris <[email protected]> | 2021-03-30 20:48:37 +0100 |
| commit | 96037aa80717420d3a3b077b38e8cff571488ba8 (patch) | |
| tree | 9b70116eddcfaaa699d90041f83e0461b79900ae | |
| parent | HelpChannels: refactor get_closing_time (diff) | |
Enumerate all possible values for closed_on in docstring
| -rw-r--r-- | bot/exts/help_channels/_cog.py | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/bot/exts/help_channels/_cog.py b/bot/exts/help_channels/_cog.py index 183ee8a9b..658e50201 100644 --- a/bot/exts/help_channels/_cog.py +++ b/bot/exts/help_channels/_cog.py @@ -366,7 +366,10 @@ class HelpChannels(commands.Cog): Remove the cooldown role from the channel claimant if they have no other channels claimed. Cancel the scheduled cooldown role removal task. - `closed_on` is the reason that the channel was closed for. Examples: "cleanup", "command", "claimant_timeout" + `closed_on` is the reason that the channel was closed for. Possible values for this are: + "cleanup", "command", "claimant_timeout", "others_timeout", "deleted". + All values, except for "command", get prefixed with "auto." within `_stats.report_complete_session()` + before being added to the bot's stats. """ claimant_id = await _caches.claimants.get(channel.id) _unclaim_channel = self._unclaim_channel |