Add extra_func docs after pulling

main/extra_func.py

@@ -90,7 +90,13 @@ class ZendeskAdmin:
         """
         return self.admin.users.search(email).values[0]
 
-    def get_group(self, name):
+    def get_group(self, name: str) -> str:
+        """
+        Функция возвращает группы, к которым принадлежит пользователь.
+
+        :param name: Имя пользователя
+        :return: Группы пользователя (в случае отствия None)
+        """
         groups = self.admin.search(name)
         for group in groups:
             return group
@@ -195,7 +201,7 @@ def make_light_agent(user_profile: UserProfile, who_changes: User) -> UserProfil
 
 def get_users_list() -> list:
     """
-        Функция **get_users_list** возвращает список пользователей Zendesk, относящихся к организации.
+        Функция **get_users_list** возвращает список пользователей Zendesk, относящихся к организации SYSTEM.
     """
     zendesk = ZendeskAdmin()
 
@@ -249,7 +255,7 @@ def get_user_organization(email: str) -> str:
 
 def check_user_auth(email: str, password: str) -> bool:
     """
-    Функция проверяет, верны ли входные данные
+    Функция проверяет, верны ли входные данные.
 
     :raise: :class:`APIException`: исключение, вызываемое если пользователь не аутентифицирован
     """
@@ -266,7 +272,14 @@ def check_user_auth(email: str, password: str) -> bool:
     return True
 
 
-def update_user_in_model(profile, zendesk_user):
+def update_user_in_model(profile: UserProfile, zendesk_user: User) -> UserProfile:
+    """
+    Функция обновляет профиль пользователя при изменении данных пользователя на Zendesk.
+
+    :param profile: Профиль пользователя
+    :param zendesk_user: Данные пользователя в Zendesk
+    :return: Обновленный профиль пользователя
+    """
     profile.name = zendesk_user.name
     profile.role = zendesk_user.role
     profile.image = zendesk_user.photo['content_url'] if zendesk_user.photo else None