From 1142588abda79d1b3c5a94449cf8074964df9228 Mon Sep 17 00:00:00 2001 From: Gareth Coles Date: Sun, 21 Apr 2019 22:28:57 +0100 Subject: A whole bunch of docstrings. --- pydis_site/apps/api/models/utils.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'pydis_site/apps/api/models/utils.py') diff --git a/pydis_site/apps/api/models/utils.py b/pydis_site/apps/api/models/utils.py index 731486e7..8f590392 100644 --- a/pydis_site/apps/api/models/utils.py +++ b/pydis_site/apps/api/models/utils.py @@ -2,13 +2,11 @@ from operator import itemgetter class ModelReprMixin: - """ - Adds a `__repr__` method to the model subclassing this - mixin which will display the model's class name along - with all parameters used to construct the object. - """ + """Mixin providing a `__repr__()` to display model class name and initialisation parameters.""" def __repr__(self): + """Returns the current model class name and initialisation parameters.""" + attributes = ' '.join( f'{attribute}={value!r}' for attribute, value in sorted( -- cgit v1.2.3