Change extra_func documentation

main/extra_func.py

@@ -10,13 +10,13 @@ class ZendeskAdmin:
     """
         Класс **ZendeskAdmin** существует, чтобы в каждой фунциии отдельно не проверять аккаунт администратора
 
-        :param credentials:  Полномочия пользователя (первым указывается учетная запись организации в Zendesk)
+        :param credentials:  Полномочия (первым указывается учетная запись организации в Zendesk)
         :type credentials: :class:`list of dictionaries`
-        :param email: Email пользователя, указанный в Zendesk
+        :param email: Email администратора, указанный в env
         :type email: :class:`email`
-        :param token: Токен пользователя (формируется в Zendesk)
+        :param token: Токен администратора (формируется в Zendesk, указывается в env)
         :type token: :class:`str`
-        :param password: Пароль пользователя, указанный в Zendesk
+        :param password: Пароль администратора, указанный в env
         :type password: :class:`str`
     """
 
@@ -31,6 +31,14 @@ class ZendeskAdmin:
         self.create_admin()
 
     def check_user(self, email: str) -> bool:
+        """
+            Функция **check_user** осуществляет проверку существования пользователя в Zendesk
+
+            :param email: Электронная почта пользователя
+            :type email: :class:`email`
+            :return: True, если существует, иначе False
+            :rtype: :class:`bool`
+        """
         return True if self.admin.search(email, type='user') else False
 
     def get_user_name(self, email: str) -> str: