diff options
author | 2022-02-03 20:18:41 +0000 | |
---|---|---|
committer | 2022-02-03 20:18:41 +0000 | |
commit | dab2673d5e6ba387340efc5b9e4ddebb85795903 (patch) | |
tree | 1dd7d2c2cc9994c250b90a20c6fedabc2e005dfb | |
parent | 🚨 Linting fixes (diff) |
💡 Update docstrings to reflect changes
-rw-r--r-- | bot/exts/help_channels/_message.py | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/bot/exts/help_channels/_message.py b/bot/exts/help_channels/_message.py index d867dd93d..f8f10f774 100644 --- a/bot/exts/help_channels/_message.py +++ b/bot/exts/help_channels/_message.py @@ -128,6 +128,9 @@ async def notify_none_remaining(last_notification: Arrow) -> t.Optional[Arrow]: """ 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_minutes` - minimum interval between notifications * `HelpChannels.notify_none_remaining` - toggle none_remaining notifications @@ -171,6 +174,9 @@ async def notify_running_low(number_of_channels_left: int, last_notification: Ar This will include the number of dormant channels left `number_of_channels_left` + If a notification was sent, return the time at which the message was sent. + Otherwise, return None. + Configuration: * `HelpChannels.notify_minutes` - minimum interval between notifications * `HelpChannels.notify_running_low` - toggle running_low notifications |