make docstring more explicit about the returned content

1 files changed, 6 insertions, 1 deletions

diff --git a/pydis_site/apps/api/views.py b/pydis_site/apps/api/views.py
index 836f11ce..f76a78ff 100644
--- a/pydis_site/apps/api/views.py
+++ b/pydis_site/apps/api/views.py
@@ -100,7 +100,12 @@ class RulesView(APIView):
 
     # `format` here is the result format, we have a link format here instead.
     def get(self, request, format=None):  # noqa: D102,ANN001,ANN201
-        """Returns a list of our community rules coupled with their keywords."""
+        """
+        Returns a list of our community rules coupled with their keywords.
+
+        Each item in the returned list is a tuple with the rule as first item
+        and a list of keywords that match that rules as second item.
+        """
         link_format = request.query_params.get('link_format', 'md')
         if link_format not in ('html', 'md'):
             raise ParseError(