added comments

Author: RigalHD

pyproject.toml

@@ -72,6 +72,8 @@ ignore = [
   'SIM108',
   'FBT001',
   'FBT002',
+  'D212',
+  'W293',
   # Does not work correctly
   'TC002',
   'TC001',

src/telegram_assistant/bot/logic/keyboards/pagination.py

@@ -9,7 +9,8 @@ def pagination(
     page: int,
     models_per_page: int = 5,
 ) -> tuple[tuple[BaseModel], tuple[InlineKeyboardButton]]:
-    """Предназначается для удобной паггинации клавиатур aiogram
+    """
+    Предназначается для удобной паггинации клавиатур aiogram
     :param models: Последовательность моделей
     :switch_page_buttons: Кнопки для переключения страниц по шаблону [<Кнопка cлед. стр.>, <Кнопка пред. стр.>]
     :param page: Номер страницы

src/telegram_assistant/parser/base_parser.py

@@ -6,8 +6,9 @@
 
 class BaseParser:
     def parse_admission_rules(self, html: bool = False) -> str:
-        """:param html: False - возвращает результат в формате текста;
-        True - возвращает результат в формате HTML.
+        """
+        :param html: False - возвращает результат в формате текста;
+                     True - возвращает результат в формате HTML.
         """
         all_text = []
 

src/telegram_assistant/parser/table_parser.py

@@ -11,9 +11,26 @@ def lite_parse_table(
         data_row_offset: int,
         table_number: int | None = None,
     ) -> dict[str, str]:
+        """
+        Парсит HTML-таблицы.
+
+        :param url: URL-адрес страницы для парсинга;
+        :param table_class: HTML-класс таблицы для парсинга;
+        :param row_class_name: HTML-класс ряда таблицы без номера
+                               (Пример: было - row11, стало - row);
+        :param data_row_offset: количество рядов, парсинг которых не должен проводиться
+                                (Пример: первые 2 ряда таблицы - названия колонок. Значением будет 2);
+        :param table_number: Применяется только в случае, если на сайте присутствует
+                             две или более таблицы с одинаковым названием класса;
+
+        Возвращает результат в формате словаря:
+            ключ - ряд в таблице (Пример: row1, row15 и т.п.),
+            значение - первая ячейка ряда.
+        """
         response = requests.get(url=url)
 
         bs = BeautifulSoup(response.text, "html.parser")
+
         if table_number is None:
             table = bs.find(class_=table_class)
         else:
@@ -39,7 +56,25 @@ def parse_specific_row(
         row_class_name: str,
         row_number: int,
         table_number: int | None = None,
-    ) -> dict[str, str]:
+    ) -> dict[str, str | dict[str, str]]:
+        """
+        Подробно парсит ряд HTML-таблицы.
+
+        :param url: URL-адрес страницы для парсинга;
+        :param table_class: HTML-класс таблицы для парсинга;
+        :param row_class_name: HTML-класс ряда таблицы без номера
+                               (Пример: было - row11, стало - row);
+        :param row_number: номер ряда таблицы, парсинг которого будет произведен;
+        :param table_number: Применяется только в случае, если на сайте присутствует
+                             две или более таблицы c одинаковым названием класса;
+
+        Возвращает результат в формате словаря:
+            ключ - имя колонки в таблице,
+            значение - значение ячейки ряда c этим именем
+                       ИЛИ словарь c "подколонками" в качестве ключа
+                                и значение ячейки ряда c именем колонки.
+
+        """
         response = requests.get(url=url)
 
         name_rows_count = 2

src/telegram_assistant/parser/url_parser.py

@@ -6,7 +6,8 @@
 
 class URLParser:
     def parse_teachers(self) -> dict[str, str]:
-        """Возвращает словарь c такой структурой:
+        """
+        Возвращает словарь c такой структурой:
         ключ - ФИО учителя,
         значение - URL-адрес его профиля.
         """