From 2ce272d2066129968f8c3b997d97475578732ef1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A1=D1=82=D0=B5=D0=BF=D0=B0=D0=BD=D0=B5=D0=BD=D0=BA?= =?UTF-8?q?=D0=BE=20=D0=9E=D0=BB=D1=8C=D0=B3=D0=B0?= Date: Tue, 23 Mar 2021 20:22:42 +0300 Subject: [PATCH] Add models docs after pulling --- main/models.py | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/main/models.py b/main/models.py index 15ec6b9..8c21293 100644 --- a/main/models.py +++ b/main/models.py @@ -7,8 +7,9 @@ from django.utils import timezone class UserProfile(models.Model): """ - Модель профиля пользователя + Модель профиля пользователя. + Профиль создается и изменяется при создании и изменении модель User. """ class Meta: @@ -36,8 +37,7 @@ def save_user_profile(sender, instance, **kwargs): class RoleChangeLogs(models.Model): """ - Модель для логирования изменений ролей пользователя - + Модель для логирования изменений ролей пользователя. """ user = models.ForeignKey(to=User, on_delete=models.CASCADE, @@ -50,6 +50,15 @@ class RoleChangeLogs(models.Model): class UnassignedTicketStatus(models.IntegerChoices): + """ + Класс статусов нераспределенных тикетов. + + :param UNASSIGNED: Снят с пользователя, перенесён в буферную группу + :param RESTORED: Авторство восстановлено + :param NOT_FOUND: Пока нас не было, тикет испарился из буферной группы. Дополнительные действия не требуются + :param CLOSED: Тикет уже был закрыт. Дополнительные действия не требуются + :param SOLVED: Тикет решён. Записан на пользователя с почтой SOLVED_TICKETS_EMAIL + """ UNASSIGNED = 0, 'Снят с пользователя, перенесён в буферную группу' RESTORED = 1, 'Авторство восстановлено' NOT_FOUND = 2, 'Пока нас не было, тикет испарился из буферной группы. Дополнительные действия не требуются' @@ -58,6 +67,9 @@ class UnassignedTicketStatus(models.IntegerChoices): class UnassignedTicket(models.Model): - assignee = models.ForeignKey(to=User, on_delete=models.CASCADE, related_name='tickets') + """ + Модель нераспределенного тикета. + """ + assignee = models.ForeignKey(to=User, on_delete=models.CASCADE, related_name='tickets', help_text='Пользователь, с которого снят тикет') ticket_id = models.IntegerField(help_text='Номер тикера, для которого сняли ответственного') - status = models.IntegerField(choices=UnassignedTicketStatus.choices, default=UnassignedTicketStatus.UNASSIGNED) + status = models.IntegerField(choices=UnassignedTicketStatus.choices, default=UnassignedTicketStatus.UNASSIGNED, help_text='Статус тикета')