aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar MarkKoz <[email protected]>2021-01-03 20:11:49 -0800
committerGravatar MarkKoz <[email protected]>2021-01-04 23:20:00 -0800
commit6b60dbcdd695220d2e02349d4707197253095639 (patch)
treeacb7ef8316c6546ac99f22a2f67a189a6dc3660b
parentHelpChannels: refactor the close command check (diff)
HelpChannels: clarify close command docstring
Referencing internal functions in public-facing documentation is not helpful to users.
-rw-r--r--bot/exts/help_channels/_cog.py3
1 files changed, 1 insertions, 2 deletions
diff --git a/bot/exts/help_channels/_cog.py b/bot/exts/help_channels/_cog.py
index a15e6295e..2b7cfcba7 100644
--- a/bot/exts/help_channels/_cog.py
+++ b/bot/exts/help_channels/_cog.py
@@ -178,8 +178,7 @@ class HelpChannels(commands.Cog):
"""
Make the current in-use help channel dormant.
- Make the channel dormant if the user passes the `close_check`,
- delete the message that invoked this.
+ May only be invoked by the channel's claimant or by staff.
"""
# Don't use a discord.py check because the check needs to fail silently.
if await self.close_check(ctx):