From 09731743bf1c8bc334001413cddd16d11a55cf8f Mon Sep 17 00:00:00 2001
From: Scragly <29337040+scragly@users.noreply.github.com>
Date: Fri, 8 Feb 2019 01:15:03 +1000
Subject: Update _has_invites method docstring.

---
 bot/cogs/filtering.py | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/bot/cogs/filtering.py b/bot/cogs/filtering.py
index d3dc0f66e..25aaf8420 100644
--- a/bot/cogs/filtering.py
+++ b/bot/cogs/filtering.py
@@ -303,8 +303,10 @@ class Filtering:
 
     async def _has_invites(self, text: str) -> Union[dict, bool]:
         """
-        Returns True if the text contains an invite which is not on the guild_invite_whitelist in
-        config.yml
+        Checks if there's any invites in the text content that aren't in the guild whitelist.
+
+        If any are detected, a dictionary of invite data is returned, with a key per invite.
+        If none are detected, False is returned.
 
         Attempts to catch some of common ways to try to cheat the system.
         """
-- 
cgit v1.2.3