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

View File

@@ -18,6 +18,9 @@ logger = logging.getLogger(__name__)
@python_2_unicode_compatible
class Comment(models.Model):
"""
Model to store one comment per document per user per date & time.
"""
document = models.ForeignKey(
db_index=True, on_delete=models.CASCADE, related_name='comments',
to=Document, verbose_name=_('Document')