Documentation fix

Add enchant, remove intersphinx useless links, remove napoleon, fix todos
This commit is contained in:
Andrew Smirnov
2021-03-04 20:54:45 +03:00
parent 656081295e
commit 1d7ff524b0
5 changed files with 25 additions and 29 deletions

View File

@@ -74,7 +74,10 @@ class ZendeskAdmin:
def get_user(self, email: str) -> str:
"""
Функция **get_user** возвращает пользователя (объект) по его email
Функция **get_user** возвращает пользователя (объект) по его email
:param email: email пользователя
:return: email пользователя, найденного в БД
"""
return self.admin.users.search(email).values[0]

View File

@@ -5,10 +5,7 @@ from django.dispatch import receiver
class UserProfile(models.Model):
"""
Модель профиля пользователя
"""
"""Модель профиля пользователя"""
user = models.OneToOneField(to=User, on_delete=models.CASCADE, help_text='Пользователь')
role = models.CharField(default='None', max_length=100, help_text='Код роли пользователя')
@@ -28,10 +25,7 @@ def save_user_profile(sender, instance, **kwargs):
class RoleChangeLogs(models.Model):
"""
Модель для логирования изменений ролей пользователя
"""
"""Модель для логирования изменений ролей пользователя"""
user = models.ForeignKey(to=User, on_delete=models.CASCADE, help_text='Пользователь, которому присвоили другую роль')
name = models.TextField(help_text='Имя пользователя')
new_role = models.TextField(help_text='Присвоенная роль')

View File

@@ -188,9 +188,12 @@ class AdminPageView(FormView, LoginRequiredMixin, PermissionRequiredMixin):
[make_light_agent(user) for user in users]
@staticmethod
def count_users(users: User) -> int: #.. todolist:: :this func counts users from all zendesk instead of just from a model:
def count_users(users: User) -> int:
"""
Функция подсчета количества сотрудников с ролями engineer и light_a
.. todo::
this func counts users from all zendesk instead of just from a model:
"""
engineers, light_agents = 0, 0
for user in users: