diff options
| author |  GDWR <[email protected]> | 2022-01-31 23:18:52 +0000 |
|---|---|---|
| committer | GDWR <[email protected]> | 2022-01-31 23:18:52 +0000 |
| commit | 289629cfcadf987efb28d8969516a22db52f4a77 (patch) | |
| tree | fcb31727aa804b8dde2d8643ff63577eea25e7ad | |
| parent | ♻️Rename `notify` -> `notify_none_remaining` (diff) | |
📝 Update `notify_none_remaining` docstring
| -rw-r--r-- | bot/exts/help_channels/_message.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/bot/exts/help_channels/_message.py b/bot/exts/help_channels/_message.py index 70ae8b062..e21e9a450 100644 --- a/bot/exts/help_channels/_message.py +++ b/bot/exts/help_channels/_message.py @@ -126,16 +126,15 @@ async def dm_on_open(message: discord.Message) -> None: async def notify_none_remaining(channel: discord.TextChannel, last_notification: t.Optional[Arrow]) -> t.Optional[Arrow]: """ - Send a message in `channel` notifying about a lack of available help channels. + Send a pinging message in `channel` notifying about there being no dormant channels remaining. If a notification was sent, return the time at which the message was sent. Otherwise, return None. Configuration: - - * `HelpChannels.notify` - toggle notifications - * `HelpChannels.notify_minutes` - minimum interval between notifications - * `HelpChannels.notify_roles` - roles mentioned in notifications + * `HelpChannels.notify_minutes` - minimum interval between notifications + * `HelpChannels.notify_none_remaining` - toggle notifications + * `HelpChannels.notify_none_remaining_roles` - roles mentioned in notifications """ if not constants.HelpChannels.notify_none_remaining: return |