[1] Добавлены docstring к функциям

skorohodovsa/task_1/linked_list.py

@@ -25,6 +25,21 @@ def create_linked_list(data: list[dict]) -> dict:
 
 
 def ll_insert(head: dict, name: str, phone: str) -> dict:
+    """Добавление нового или редактирование элемента в связном списке
+    
+    Если пользователь уже есть в списке, то обновятся его данные (номер телефона). В случае если
+    данных нет, то они добавляются в конец.
+
+    :param head: Список словарей с параметрами: {'name': str, 'phone': str, next: dict | None}
+    :type head: dict
+    :param name: Имя пользователя (не должно повторятся с имеющимися)
+    :type name: str
+    :param phone: Номер телефона пользователя (не должно повторятся с имеющимися)
+    :type phone: str
+    :raises ValueError: Ошибка при подаче на вход пустого списка
+    :return: Возвращает связный список с обновленными данными
+    :rtype: dict
+    """
     if head is None:
         raise ValueError("Словарь пустой!")
 
@@ -42,6 +57,21 @@ def ll_insert(head: dict, name: str, phone: str) -> dict:
 
 
 def ll_find(head: dict, name: str) -> str | None:
+    """Поиск пользователя в связном списке
+    
+    Если функция найдёт пользователя по имени, то вернёт его номер телефона. 
+    В противном случае будет возвращено значение None.
+    
+    В случае повторяющихся имен в списке, выведется выше стоящие
+
+    :param head: Список словарей с параметрами: {'name': str, 'phone': str, next: dict | None}
+    :type head: dict
+    :param name: Имя пользователя
+    :type name: str
+    :raises ValueError: Ошибка при подаче на вход пустого списка
+    :return: Возвращает номер телефона найденного пользователя, иначе None
+    :rtype: str | None
+    """
     if head is None:
         raise ValueError("Словарь пустой!")
 
@@ -54,6 +84,16 @@ def ll_find(head: dict, name: str) -> str | None:
 
 
 def ll_delete(head: dict, name: str) -> dict:
+    """Удаление пользователя из связного списка
+
+    :param head: Список словарей с параметрами: {'name': str, 'phone': str, next: dict | None}
+    :type head: dict
+    :param name: Имя пользователя
+    :type name: str
+    :raises ValueError: Ошибка при подаче на вход пустого списка
+    :return: Возвращает связный список с обновленными данными
+    :rtype: dict
+    """
     if head is None:
         raise ValueError("Словарь пустой!")