Address the latest review. ✈

14 files changed, 20 insertions, 1 deletions

diff --git a/pydis_site/apps/api/models/bot/bot_setting.py b/pydis_site/apps/api/models/bot/bot_setting.py
index a52f3e34..ee9838b7 100644
--- a/pydis_site/apps/api/models/bot/bot_setting.py
+++ b/pydis_site/apps/api/models/bot/bot_setting.py
@@ -7,6 +7,7 @@ from pydis_site.apps.api.models.utils import ModelReprMixin
 
 def validate_bot_setting_name(name):
     """Raises a ValidationError if the given name is not a known setting."""
+
     known_settings = (
         'defcon',
     )
diff --git a/pydis_site/apps/api/models/bot/documentation_link.py b/pydis_site/apps/api/models/bot/documentation_link.py
index f844ae04..30379396 100644
--- a/pydis_site/apps/api/models/bot/documentation_link.py
+++ b/pydis_site/apps/api/models/bot/documentation_link.py
@@ -23,4 +23,5 @@ class DocumentationLink(ModelReprMixin, models.Model):
 
     def __str__(self):
         """Returns the package and URL for the current documentation link, for display purposes."""
+
         return f"{self.package} - {self.base_url}"
diff --git a/pydis_site/apps/api/models/bot/infraction.py b/pydis_site/apps/api/models/bot/infraction.py
index da91d6c2..7669352f 100644
--- a/pydis_site/apps/api/models/bot/infraction.py
+++ b/pydis_site/apps/api/models/bot/infraction.py
@@ -60,6 +60,7 @@ class Infraction(ModelReprMixin, models.Model):
 
     def __str__(self):
         """Returns some info on the current infraction, for display purposes."""
+
         s = f"#{self.id}: {self.type} on {self.user_id}"
         if self.expires_at:
             s += f" until {self.expires_at}"
diff --git a/pydis_site/apps/api/models/bot/message.py b/pydis_site/apps/api/models/bot/message.py
index 7332cc8d..6b566620 100644
--- a/pydis_site/apps/api/models/bot/message.py
+++ b/pydis_site/apps/api/models/bot/message.py
@@ -51,4 +51,5 @@ class Message(ModelReprMixin, models.Model):
 
     class Meta:
         """Metadata provided for Django's ORM."""
+
         abstract = True
diff --git a/pydis_site/apps/api/models/bot/off_topic_channel_name.py b/pydis_site/apps/api/models/bot/off_topic_channel_name.py
index 0891f811..2f55a131 100644
--- a/pydis_site/apps/api/models/bot/off_topic_channel_name.py
+++ b/pydis_site/apps/api/models/bot/off_topic_channel_name.py
@@ -16,4 +16,5 @@ class OffTopicChannelName(ModelReprMixin, models.Model):
 
     def __str__(self):
         """Returns the current off-topic name, for display purposes."""
+
         return self.name
diff --git a/pydis_site/apps/api/models/bot/reminder.py b/pydis_site/apps/api/models/bot/reminder.py
index decc9391..ae45b5de 100644
--- a/pydis_site/apps/api/models/bot/reminder.py
+++ b/pydis_site/apps/api/models/bot/reminder.py
@@ -42,4 +42,5 @@ class Reminder(ModelReprMixin, models.Model):
 
     def __str__(self):
         """Returns some info on the current reminder, for display purposes."""
+
         return f"{self.content} on {self.expiration} by {self.author}"
diff --git a/pydis_site/apps/api/models/bot/role.py b/pydis_site/apps/api/models/bot/role.py
index 34e74009..ad043bd6 100644
--- a/pydis_site/apps/api/models/bot/role.py
+++ b/pydis_site/apps/api/models/bot/role.py
@@ -46,4 +46,5 @@ class Role(ModelReprMixin, models.Model):
 
     def __str__(self):
         """Returns the name of the current role, for display purposes."""
+
         return self.name
diff --git a/pydis_site/apps/api/models/bot/snake_fact.py b/pydis_site/apps/api/models/bot/snake_fact.py
index e4486d41..c960cbc4 100644
--- a/pydis_site/apps/api/models/bot/snake_fact.py
+++ b/pydis_site/apps/api/models/bot/snake_fact.py
@@ -14,4 +14,5 @@ class SnakeFact(ModelReprMixin, models.Model):
 
     def __str__(self):
         """Returns the current snake fact, for display purposes."""
+
         return self.fact
diff --git a/pydis_site/apps/api/models/bot/snake_idiom.py b/pydis_site/apps/api/models/bot/snake_idiom.py
index 73ce25eb..0e8f5e94 100644
--- a/pydis_site/apps/api/models/bot/snake_idiom.py
+++ b/pydis_site/apps/api/models/bot/snake_idiom.py
@@ -14,4 +14,5 @@ class SnakeIdiom(ModelReprMixin, models.Model):
 
     def __str__(self):
         """Returns the current idiom, for display purposes."""
+
         return self.idiom
diff --git a/pydis_site/apps/api/models/bot/snake_name.py b/pydis_site/apps/api/models/bot/snake_name.py
index 6d33f872..b6ea6202 100644
--- a/pydis_site/apps/api/models/bot/snake_name.py
+++ b/pydis_site/apps/api/models/bot/snake_name.py
@@ -21,4 +21,5 @@ class SnakeName(ModelReprMixin, models.Model):
 
     def __str__(self):
         """Returns the regular and scientific name of the current snake, for display purposes."""
+
         return f"{self.name} ({self.scientific})"
diff --git a/pydis_site/apps/api/models/bot/special_snake.py b/pydis_site/apps/api/models/bot/special_snake.py
index 5d38ab6f..662ff8e3 100644
--- a/pydis_site/apps/api/models/bot/special_snake.py
+++ b/pydis_site/apps/api/models/bot/special_snake.py
@@ -24,4 +24,5 @@ class SpecialSnake(ModelReprMixin, models.Model):
 
     def __str__(self):
         """Returns the name of the current snake, for display purposes."""
+
         return self.name
diff --git a/pydis_site/apps/api/models/bot/tag.py b/pydis_site/apps/api/models/bot/tag.py
index b75ccec9..99819e42 100644
--- a/pydis_site/apps/api/models/bot/tag.py
+++ b/pydis_site/apps/api/models/bot/tag.py
@@ -184,4 +184,5 @@ class Tag(ModelReprMixin, models.Model):
 
     def __str__(self):
         """Returns the title of this tag, for display purposes."""
+
         return self.title
diff --git a/pydis_site/apps/api/models/bot/user.py b/pydis_site/apps/api/models/bot/user.py
index d4deb630..8b995b59 100644
--- a/pydis_site/apps/api/models/bot/user.py
+++ b/pydis_site/apps/api/models/bot/user.py
@@ -50,4 +50,5 @@ class User(ModelReprMixin, models.Model):
 
     def __str__(self):
         """Returns the name and discriminator for the current user, for display purposes."""
+
         return f"{self.name}#{self.discriminator}"
diff --git a/pydis_site/apps/api/viewsets/bot/snake_name.py b/pydis_site/apps/api/viewsets/bot/snake_name.py
index 91adae00..8e63a542 100644
--- a/pydis_site/apps/api/viewsets/bot/snake_name.py
+++ b/pydis_site/apps/api/viewsets/bot/snake_name.py
@@ -45,7 +45,13 @@ class SnakeNameViewSet(ViewSet):
 
         return SnakeName.objects.all()
 
-    def list(self, request):  # noqa
+    def list(self, request):
+        """
+        DRF method for listing SnakeName entries.
+
+        Called by the Django Rest Framework in response to the corresponding HTTP request.
+        """
+
         if request.query_params.get('get_all'):
             queryset = self.get_queryset()
             serialized = self.serializer_class(queryset, many=True)