From 43c407cc925ea27faab93d86e54bfce5cca8a8b1 Mon Sep 17 00:00:00 2001
From: Hassan Abouelela <47495861+HassanAbouelela@users.noreply.github.com>
Date: Sun, 10 Jan 2021 16:16:34 +0300
Subject: Improves Unsilence Wrapper Docstring

Modifies the unsilence wrapper docstring to make the arguments and
behavior more clear.
---
 bot/exts/moderation/silence.py | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/bot/exts/moderation/silence.py b/bot/exts/moderation/silence.py
index e91e558ec..26aa77b61 100644
--- a/bot/exts/moderation/silence.py
+++ b/bot/exts/moderation/silence.py
@@ -209,7 +209,12 @@ class Silence(commands.Cog):
 
     @lock_arg(LOCK_NAMESPACE, "channel", raise_error=True)
     async def _unsilence_wrapper(self, channel: TextOrVoiceChannel, ctx: Optional[Context] = None) -> None:
-        """Unsilence `channel` and send a success/failure message."""
+        """
+        Unsilence `channel` and send a success/failure message to ctx.channel.
+
+        If ctx is None or not passed, `channel` is used in its place.
+        If `channel` and ctx.channel are the same, only one message is sent.
+        """
         msg_channel = channel
         if ctx is not None:
             msg_channel = ctx.channel
-- 
cgit v1.2.3