diff options
| author |  Amrou Bellalouna <[email protected]> | 2022-09-18 18:38:02 +0100 |
|---|---|---|
| committer | Amrou Bellalouna <[email protected]> | 2022-09-18 18:38:02 +0100 |
| commit | a75ba77bc8b83af97decde6c5ac4317bb3b5253d (patch) | |
| tree | 0aeec2baa45335d2980becce8be2fb9b9ceac47c /pydis_site | |
| parent | add collection of keywords per rule (diff) | |
add docstrings explaining the values that the Rules view returns
Diffstat (limited to 'pydis_site')
| -rw-r--r-- | pydis_site/apps/api/views.py | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/pydis_site/apps/api/views.py b/pydis_site/apps/api/views.py index f96d6a8d..66f4b18c 100644 --- a/pydis_site/apps/api/views.py +++ b/pydis_site/apps/api/views.py @@ -100,6 +100,7 @@ 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.""" link_format = request.query_params.get('link_format', 'md') if link_format not in ('html', 'md'): raise ParseError( |