diff options
| author |  MarkKoz <[email protected]> | 2020-03-30 09:05:30 -0700 |
|---|---|---|
| committer | MarkKoz <[email protected]> | 2020-03-30 09:05:56 -0700 |
| commit | 58fad6541fbff07c32883dcd2b4d046b1ef9d9b0 (patch) | |
| tree | 9982b00e48fb8412ce160a3cea1b5089dc66591f | |
| parent | HelpChannels: fix typos in docstrings (diff) | |
HelpChannels: use constant names instead of default values in docstring
| -rw-r--r-- | bot/cogs/help_channels.py | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/bot/cogs/help_channels.py b/bot/cogs/help_channels.py index 984a11f61..ff8d31ded 100644 --- a/bot/cogs/help_channels.py +++ b/bot/cogs/help_channels.py @@ -78,20 +78,19 @@ class HelpChannels(Scheduler, commands.Cog): Available Category * Contains channels which are ready to be occupied by someone who needs help - * Will always contain 2 channels; refilled automatically from the pool of dormant channels + * Will always contain `constants.HelpChannels.max_available` channels; refilled automatically + from the pool of dormant channels * Prioritise using the channels which have been dormant for the longest amount of time * If there are no more dormant channels, the bot will automatically create a new one - * Configurable with `constants.HelpChannels.max_available` * 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` In Use Category * Contains all channels which are occupied by someone needing help - * Channel moves to dormant category after 45 minutes of being idle - * Configurable with `constants.HelpChannels.idle_minutes` - * Helpers+ command can prematurely mark a channel as dormant - * Configurable with `constants.HelpChannels.cmd_whitelist` + * Channel moves to dormant category after `constants.HelpChannels.idle_minutes` of being idle + * Command can prematurely mark a channel as dormant + * 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 Dormant Category |