aboutsummaryrefslogtreecommitdiffstats
path: root/bot
diff options
context:
space:
mode:
authorGravatar Chris Lovering <[email protected]>2022-04-26 18:41:30 +0100
committerGravatar Chris Lovering <[email protected]>2022-08-19 10:28:02 +0100
commit631c7da337435e3667b5f4af89fbd7657ff5bc3c (patch)
tree38933df8a58487520b6314e03263bcf33ecb61f2 /bot
parentAdd command to delete bot messages in DMs with sir-lancebot (diff)
Improve the docstring for the action_bookmark function
Diffstat (limited to 'bot')
-rw-r--r--bot/exts/utilities/bookmark.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/bot/exts/utilities/bookmark.py b/bot/exts/utilities/bookmark.py
index 521a7bfa..2d21fa8a 100644
--- a/bot/exts/utilities/bookmark.py
+++ b/bot/exts/utilities/bookmark.py
@@ -64,7 +64,11 @@ class Bookmark(commands.Cog):
target_message: discord.Message,
title: str
) -> None:
- """Sends the bookmark DM, or sends an error embed when a member bookmarks a message."""
+ """
+ Sends the given target_message as a bookmark to the member in DMs to the user.
+
+ Send an error embed instead if the member has DMs disabled.
+ """
embed = self.build_bookmark_dm(target_message, title)
try:
await member.send(embed=embed)