diff options
| author |  Steele <[email protected]> | 2020-11-29 14:15:19 -0500 |
|---|---|---|
| committer | Steele <[email protected]> | 2020-11-29 14:15:19 -0500 |
| commit | 15593de0a1a503a39aa29031061bc17ac26e4230 (patch) | |
| tree | ad5d164422c62177ce59d861399f70f7025c4925 | |
| parent | Merge branch 'master' of https://github.com/python-discord/bot into Stelercus... (diff) | |
Corrected `unclaim_channel` docstring to comply with style guide
| -rw-r--r-- | bot/exts/help_channels/_cog.py | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/bot/exts/help_channels/_cog.py b/bot/exts/help_channels/_cog.py index 86eb91b02..983c5d183 100644 --- a/bot/exts/help_channels/_cog.py +++ b/bot/exts/help_channels/_cog.py @@ -395,8 +395,10 @@ class HelpChannels(commands.Cog): async def unclaim_channel(self, channel: discord.TextChannel) -> None: """ - Remove the claimant from the claimant cache and remove the cooldown role - if it was their last open help channel. + Mark the channel as unclaimed and remove the cooldown role from the claimant if needed. + + The role is only removed if they have no claimed channels left once the current one is unclaimed. + This method also handles canceling the automatic removal of the cooldown role. """ claimant_id = await _caches.claimants.pop(channel.id) |