diff options
author | 2020-09-18 12:40:24 +1000 | |
---|---|---|
committer | 2020-09-18 12:40:24 +1000 | |
commit | 77c9e3ffce7992706202cf20ae3addf42c4dbf6c (patch) | |
tree | 5990296b545d43b0e8db30391287e885df2892e5 /pydis_site/apps/api/models | |
parent | Add verbose names for user fields that need capitalisation fixes. (diff) |
Add return types and docstrings for new user admin changes.
Diffstat (limited to 'pydis_site/apps/api/models')
-rw-r--r-- | pydis_site/apps/api/models/bot/user.py | 11 |
1 files changed, 8 insertions, 3 deletions
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) |