diff options
| author |  MarkKoz <[email protected]> | 2020-04-17 09:23:57 -0700 |
|---|---|---|
| committer | MarkKoz <[email protected]> | 2020-04-17 11:43:33 -0700 |
| commit | 244b23a4d36f0117e7a385979a1b03e4534cffb4 (patch) | |
| tree | d63957d56b11d5dd06623e630b77a372c09425c3 | |
| parent | HelpChannels: add/remove a cooldown role rather than using overwrites (diff) | |
HelpChannels: add info about cooldown role & dormant cmd to docstring
| -rw-r--r-- | bot/cogs/help_channels.py | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/bot/cogs/help_channels.py b/bot/cogs/help_channels.py index 47e74a2e5..589342098 100644 --- a/bot/cogs/help_channels.py +++ b/bot/cogs/help_channels.py @@ -89,12 +89,15 @@ class HelpChannels(Scheduler, commands.Cog): * If there are no more dormant channels, the bot will automatically create a new one * If there are no dormant channels to move, helpers will be notified (see `notify()`) * When a channel becomes available, the dormant embed will be edited to show `AVAILABLE_MSG` + * User can only claim a channel at an interval `constants.HelpChannels.claim_minutes` + * To keep track of cooldowns, user which claimed a channel will have a temporary role In Use Category * Contains all channels which are occupied by someone needing help * Channel moves to dormant category after `constants.HelpChannels.idle_minutes` of being idle * Command can prematurely mark a channel as dormant + * Channel claimant is allowed to use the command * Allowed roles for the command are configurable with `constants.HelpChannels.cmd_whitelist` * When a channel becomes dormant, an embed with `DORMANT_MSG` will be sent |