From f9e6b79f0124755a90bb7b48f9f5e5104c260d7a 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?=
 <stepanenko_olga@mail.ru>
Date: Tue, 2 Mar 2021 09:52:18 +0300
Subject: [PATCH] Change models documentation using snippets

---
 main/models.py | 34 +++++++++-------------------------
 1 file changed, 9 insertions(+), 25 deletions(-)

diff --git a/main/models.py b/main/models.py
index 2cf76ac..8665570 100644
--- a/main/models.py
+++ b/main/models.py
@@ -8,20 +8,12 @@ class UserProfile(models.Model):
     """
            Модель профиля пользователя
 
-           :param user: OneToOneField к модели :class:`django.contrib.auth.models.User`
-           :param role: Код роли пользователя
-           :type role: :class:`integer`
-           :param image: Аватарка
-           :type image: :class:`img`
-           :param name: Имя пользователя на нашем сайте
-           :type name: :class:`str`
-
     """
 
-    user = models.OneToOneField(to=User, on_delete=models.CASCADE)
-    role = models.CharField(default='None', max_length=100)
-    image = models.URLField(null=True, blank=True)
-    name = models.CharField(default='None', max_length=100)
+    user = models.OneToOneField(to=User, on_delete=models.CASCADE, help_text='Пользователь')
+    role = models.CharField(default='None', max_length=100, help_text='Код роли пользователя')
+    image = models.URLField(null=True, blank=True, help_text='Аватарка')
+    name = models.CharField(default='None', max_length=100, help_text='Имя пользователя на нашем сайте')
 
 
 @receiver(post_save, sender=User)
@@ -39,17 +31,9 @@ class RoleChangeLogs(models.Model):
     """
         Модель для логирования изменений ролей пользователя
 
-        :param user: Пользователь, которому присвоили другую роль,  ForeignKey к модели :class:`django.contrib.auth.models.User`
-        :param name: Имя пользователя
-        :type name: :class:`str`
-        :param new_role: Присвоенная роль
-        :type new_role: :class:`str`
-        :param change_time: Дата изменения роли`
-        :type change_time: :class:`datetime.datetime`
-        :param changed_by: Кем была изменена роль, ForeignKey к модели :class:`django.contrib.auth.models.User`
     """
-    user = models.ForeignKey(to=User, on_delete=models.CASCADE)
-    name = models.TextField()
-    new_role = models.TextField()
-    change_time = models.DateTimeField()
-    changed_by = models.ForeignKey(to=User, on_delete=models.CASCADE, related_name='changed_by')
+    user = models.ForeignKey(to=User, on_delete=models.CASCADE, help_text='Пользователь, которому присвоили другую роль')
+    name = models.TextField(help_text='Имя пользователя')
+    new_role = models.TextField(help_text='Присвоенная роль')
+    change_time = models.DateTimeField(help_text='Дата и время изменения роли')
+    changed_by = models.ForeignKey(to=User, on_delete=models.CASCADE, related_name='changed_by', help_text='Кем была изменена роль')