From 77c9e3ffce7992706202cf20ae3addf42c4dbf6c Mon Sep 17 00:00:00 2001
From: scragly <29337040+scragly@users.noreply.github.com>
Date: Fri, 18 Sep 2020 12:40:24 +1000
Subject: Add return types and docstrings for new user admin changes.

---
 pydis_site/apps/api/models/bot/user.py | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

(limited to 'pydis_site/apps/api/models/bot')

diff --git a/pydis_site/apps/api/models/bot/user.py b/pydis_site/apps/api/models/bot/user.py
index a8604001..afc5ba1e 100644
--- a/pydis_site/apps/api/models/bot/user.py
+++ b/pydis_site/apps/api/models/bot/user.py
@@ -64,7 +64,7 @@ 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:0>4}"
+        return f"{self.name}#{self.discriminator:04d}"
 
     @property
     def top_role(self) -> Role:
@@ -79,5 +79,10 @@ class User(ModelReprMixin, models.Model):
         return max(roles)
 
     @property
-    def username(self):
-        return f"{self.name}#{self.discriminator:04d}"
+    def username(self) -> str:
+        """
+        Returns the display version with name and discriminator as a standard attribute.
+
+        For usability in read-only fields such as Django Admin.
+        """
+        return str(self)
-- 
cgit v1.2.3