Skip to content

Commit 13ae666

Browse files
Amrou BellalounaAmrou Bellalouna
authored andcommitted
update the RulesView class' docstrings
1 parent c5fe65c commit 13ae666

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

pydis_site/apps/api/views.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,15 @@ class RulesView(APIView):
3737
3838
## Routes
3939
### GET /rules
40-
Returns a JSON array containing the server's rules:
40+
Returns a JSON array containing the server's rules
41+
coupled with a list of keywords that will be used
42+
when searching for particular rules upon using the
43+
bot's `!rule` command
4144
4245
>>> [
43-
... "Eat candy.",
44-
... "Wake up at 4 AM.",
45-
... "Take your medicine."
46+
... ("Eat candy.", ["candy", "sweet"]),
47+
... ("Wake up at 4 AM.", ["wake_up", "early", "early_bird"]),
48+
... ("Take your medicine.", ["medicine", "health"])
4649
... ]
4750
4851
Since some of the the rules require links, this view

0 commit comments

Comments
 (0)