Skip to content

Commit a75ba77

Browse files
Amrou BellalounaAmrou Bellalouna
authored andcommitted
add docstrings explaining the values that the Rules view returns
1 parent c082323 commit a75ba77

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

pydis_site/apps/api/views.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ 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."""
103104
link_format = request.query_params.get('link_format', 'md')
104105
if link_format not in ('html', 'md'):
105106
raise ParseError(

0 commit comments

Comments
 (0)