aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar MarkKoz <[email protected]>2020-11-26 14:11:40 -0800
committerGravatar MarkKoz <[email protected]>2020-11-26 14:11:40 -0800
commite5b073c5ee9c7c887a193ec05d813d259eca58ee (patch)
tree8b353df5b299fba7329d63e9a1059978c1b7a21e
parentHelp channels: don't check if task is done before awaiting (diff)
Help channels: document the return value of notify()
-rw-r--r--bot/exts/help_channels/_message.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/bot/exts/help_channels/_message.py b/bot/exts/help_channels/_message.py
index 8b058d5aa..2bbd4bdd6 100644
--- a/bot/exts/help_channels/_message.py
+++ b/bot/exts/help_channels/_message.py
@@ -96,6 +96,9 @@ async def notify(channel: discord.TextChannel, last_notification: t.Optional[dat
"""
Send a message in `channel` notifying about a lack of available help channels.
+ If a notification was sent, return the `datetime` at which the message was sent. Otherwise,
+ return None.
+
Configuration:
* `HelpChannels.notify` - toggle notifications