Add user docs

README.rst

@@ -170,7 +170,7 @@ Quickstart
 Для проверки pylint используем:
 -------------------------------
 
-pylint ../access_controller_new (каталог, где лежит проект)
+pylint ../access_controller (каталог, где лежит проект)
 
 Для приведения файлов к стандарту PEP8 используем:
 --------------------------------------------------

docs/source/overview.rst

@@ -81,6 +81,12 @@
 
 .. image:: _static/role_change.png
 
+Являясь инженером, Вы можете запросить в работу необходимое количество тикетов.
+
+.. image:: _static/take_tickets.png
+
+Назначенные тикеты будут доступны в Zendesk.
+
 ******************************************
 Управление правами доступа администратором
 ******************************************
@@ -97,4 +103,13 @@
 
 .. image:: _static/admin_manage_done.png
 
-.. |copy| unicode:: 0xA9 .. Школа программистов S101, группа 2. 2021гю
+Вы можете смотреть статистику работы пользователя.
+Для этого на странице статистика необходимо указать:
+
+* email пользователя
+* период, за который необходима статистика
+* формат отображения данных
+
+.. image:: _static/statistic.png
+
+.. |copy| unicode:: 0xA9 .. Школа программистов S101, группа 2. 2021г.

docs/source/spelling_wordlist.txt

@@ -217,6 +217,32 @@ by
 subclasses
 so
 new
-
+тикеты
-
+StatisticForm
-
+patch
+zenpy
+Mock
+редирект
+редиректа
+предустановки
+TicketListRequester
+get_tickets_list_for_user
+side
+effect
+for
+залогиненный
+предустанавливает
+переадресация
+фикстуры
+profile
+json
+аватарки
+аватарке
+locmem
+бэкенд
+has
+control
+disallowed
+test
+users
+Contents

main/models.py

@@ -79,7 +79,7 @@ class RoleChangeLogs(models.Model):
 
 class UnassignedTicketStatus(models.IntegerChoices):
     """
-    Модель статусов нераспределенных тикетов.
+    Модель статусов не распределенных тикетов.
 
     :param UNASSIGNED: Снят с пользователя, перенесён в буферную группу
     :param RESTORED: Авторство восстановлено

main/tests.py

@@ -62,7 +62,7 @@ class RegistrationTestCase(TestCase):
     """
     Класс тестирования регистрации.
 
-    Для тестов используются фикстуры с данными пользователей engeneer и light_agent (data.json).
+    Для тестов используются фикстуры с данными пользователей engineer и light_agent (data.json).
     """
     fixtures = ['fixtures/data.json']
 
@@ -101,7 +101,7 @@ class RegistrationTestCase(TestCase):
 
     def test_registration_fail_redirect(self) -> None:
         """
-        Функция тестирования неуспешной регистрации пользователя (введен email, не зарегистированный на Zendesk).
+        Функция тестирования не успешной регистрации пользователя (введен email, не зарегистрированный на Zendesk).
 
         Проверяет, что происходит редирект на страницу "registration disallowed"
         """
@@ -277,12 +277,12 @@ class MakeLightAgentTestCase(UsersBaseTestCase):
 
     @patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]])
     @patch('main.extra_func.zenpy')
-    def test_hand_over_redirect(self, _zenpy_mock: Mock, _user_tickets_Mock: Mock) -> None:
+    def test_hand_over_redirect(self, _zenpy_mock: Mock, _user_tickets_mock: Mock) -> None:
         """
         Функция тестирования переадресации инженера на рабочую страницу, после сдачи прав.
 
         :param _zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
-        :param _user_tickets_Mock: Mock, заменяющий список тикетов пользователя на пустой список.
+        :param _user_tickets_mock: Mock, заменяющий список тикетов пользователя на пустой список.
         """
         user = get_user_model().objects.get(email=self.engineer)
         resp = self.engineer_client.post(reverse_lazy('work_hand_over'))
@@ -552,7 +552,7 @@ class PasswordChangeTestCase(UsersBaseTestCase):
 
     def test_different_new_passwords(self) -> None:
         """
-        Функция тестирования смены пароля, при вводе несовпадающих новых паролей.
+        Функция тестирования смены пароля, при вводе не совпадающих новых паролей.
 
         Проверяет текст уведомления пользователя 'Введенные пароли не совпадают'.
         """
@@ -604,7 +604,7 @@ class PasswordChangeTestCase(UsersBaseTestCase):
 
     def test_invalid_new_password3(self):
         """
-        Функция тестирования попытки смены пароля, когда новый пароль не соответствует требованиям: аналогчен имени
+        Функция тестирования попытки смены пароля, когда новый пароль не соответствует требованиям: аналогичен имени
         пользователя.
 
         Проверяет текст уведомления пользователя 'Введённый пароль слишком похож на имя пользователя'.

main/views.py

@@ -420,7 +420,7 @@ def statistic_page(request: WSGIRequest) -> HttpResponse:
     """
     Функция отображения страницы статистики (для "superuser").
 
-    :param request: Данные о пользователе: email, время и интервал работы. Данные получаем через forms.StFatisticForm
+    :param request: Данные о пользователе: email, время и интервал работы. Данные получаем через forms.StatisticForm
     :return: Адресация на страницу статистики
     """