Add docstrings for almost all models

Also adds docstring to some managers and model methods.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2018-11-24 22:56:35 -04:00
parent 8c98679687
commit b04b205fb6
19 changed files with 252 additions and 20 deletions
+5
View File
@@ -8,6 +8,11 @@ from .managers import UserOptionsManager
class UserOptions(models.Model):
"""
This model stores administrative configurations for an user accounts.
At the moment it stores a boolean flag to restrict an user's
ability to change their password.
"""
user = models.OneToOneField(
on_delete=models.CASCADE, related_name='user_options',
to=settings.AUTH_USER_MODEL, unique=True, verbose_name=_('User')