Skip to content

Commit f07f03a

Browse files
Amrou BellalounaAmrou Bellalouna
authored andcommitted
make docstring more explicit about the returned content
1 parent 672ba65 commit f07f03a

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

pydis_site/apps/api/views.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,12 @@ def _format_link(description: str, link: str, target: str) -> str:
100100

101101
# `format` here is the result format, we have a link format here instead.
102102
def get(self, request, format=None): # noqa: D102,ANN001,ANN201
103-
"""Returns a list of our community rules coupled with their keywords."""
103+
"""
104+
Returns a list of our community rules coupled with their keywords.
105+
106+
Each item in the returned list is a tuple with the rule as first item
107+
and a list of keywords that match that rules as second item.
108+
"""
104109
link_format = request.query_params.get('link_format', 'md')
105110
if link_format not in ('html', 'md'):
106111
raise ParseError(

0 commit comments

Comments
 (0)