docs

docs/root/api/orchestrator/arguments.rst

@@ -3,16 +3,16 @@
 Arguments
 =========
 
-Модуль ``Arguments`` предоставляет набор классов для работы с аргументами командной строки при запуске приложения ``Argenta``. Эти аргументы позволяют настраивать поведение приложения на этапе его старта, передавая различные параметры конфигурации через интерфейс командной строки.
+Модуль ``Arguments`` предоставляет классы для работы с аргументами командной строки. Они позволяют настраивать поведение приложения в момент его запуска, передавая различные параметры конфигурации.
 
-Аргументы регистрируются в ``ArgParser`` и парсятся при запуске приложения, становясь доступными через объект ``ArgSpace``.
+Аргументы регистрируются в `ArgParser` и после обработки становятся доступными в объекте `ArgSpace`.
 
 -----
 
 ValueArgument
 -------------
 
-Класс для аргументов командной строки, требующих передачи значения. Используется для параметров конфигурации, которым необходимо указать конкретное значение при запуске приложения.
+Класс для аргументов, требующих передачи значения. Используется для параметров конфигурации, которым необходимо указать значение при запуске.
 
 .. py:class:: ValueArgument(BaseArgument)
 
@@ -27,15 +27,15 @@ ValueArgument
             is_required: bool = False,
             is_deprecated: bool = False) -> None
 
-Создает аргумент командной строки, требующий значения.
+Создаёт аргумент командной строки, требующий значения.
 
 :param name: Имя аргумента
-:param prefix: Префикс аргумента, по умолчанию ``--``
-:param help: Сообщение справки, отображаемое при ``--help``
-:param possible_values: Список допустимых значений для аргумента. Передается в параметр ``choices`` ArgumentParser
-:param default: Значение по умолчанию, используемое если аргумент не передан при запуске
-:param is_required: Обязатялен ли аргумент. Если ``True``, приложение не запустится без этого аргумента
-:param is_deprecated: Является ли аргумент устаревшим
+:param prefix: Префикс (по умолчанию ``--``)
+:param help: Сообщение для справки (``--help``)
+:param possible_values: Список допустимых значений (передаётся в `choices` `ArgumentParser`)
+:param default: Значение по умолчанию, если аргумент не передан
+:param is_required: Если ``True``, аргумент становится обязательным
+:param is_deprecated: Если ``True``, помечает аргумент как устаревший
 
 **Пример использования:**
 
@@ -83,7 +83,7 @@ ValueArgument
 BooleanArgument
 ---------------
 
-Класс для булевых аргументов командной строки, которые не требуют передачи значения. Наличие или отсутствие аргумента при запуске определяет состояние распаршенных аргументов(``True`` при наличии и ``False`` при отсутствии).
+Класс для булевых аргументов, не требующих значения. Их наличие при запуске устанавливает значение в `True`, отсутствие — в `False`.
 
 .. py:class:: BooleanArgument(BaseArgument)
 
@@ -95,12 +95,12 @@ BooleanArgument
             help: str = "Help message for the boolean argument",
             is_deprecated: bool = False) -> None
 
-Создает булевый аргумент командной строки без значения.
+Создаёт булев аргумент командной строки без значения.
 
 :param name: Имя аргумента
-:param prefix: Префикс аргумента, по умолчанию ``--``
-:param help: Сообщение справки, отображаемое при ``--help``
-:param is_deprecated: Является ли аргумент устаревшим
+:param prefix: Префикс (по умолчанию ``--``)
+:param help: Сообщение для справки (``--help``)
+:param is_deprecated: Если ``True``, помечает аргумент как устаревший
 
 **Пример использования:**
 
@@ -147,9 +147,9 @@ InputArgument
 -------------
 
 .. seealso::
-   ``InputArgument`` непосредственно связан и является наполнителем контейнера ``ArgSpace``, подробнее про него :ref:`тут <root_api_orchestrator_argspace>`.
+   ``InputArgument`` напрямую связан с контейнером ``ArgSpace`` и является его наполнителем. Подробнее о нём см. :ref:`здесь <root_api_orchestrator_argspace>`.
 
-Представляет собой распаршенный аргумент командной строки после запуска приложения. Этот класс используется внутри объекта ``ArgSpace`` для хранения значений аргументов, полученных при парсинге.
+Представляет собой обработанный аргумент командной строки. Этот класс используется внутри `ArgSpace` для хранения значений, полученных после парсинга.
 
 .. py:class:: InputArgument
 
@@ -160,35 +160,35 @@ InputArgument
             value: str | Literal[True],
             founder_class: type[BaseArgument]) -> None
 
-Создает экземпляр распарсенного входного аргумента.
+Создаёт экземпляр обработанного входного аргумента.
 
 :param name: Имя аргумента
-:param value: Значение аргумента. Для ``BooleanArgument`` всегда ``True`` если флаг передан, для ``ValueArgument`` — строка со значением
-:param founder_class: Класс-родитель, из которого был создан этот аргумент (``BooleanArgument`` или ``ValueArgument``)
+:param value: Значение аргумента. Для `BooleanArgument` — `True`, если флаг передан; для `ValueArgument` — строка со значением
+:param founder_class: Класс-родитель, из которого был создан аргумент (`BooleanArgument` или `ValueArgument`)
 
 **Атрибуты:**
 
 .. py:attribute:: name
    :no-index:
 
-   Имя аргумента в виде строки. Соответствует имени, указанному при создании ``ValueArgument`` или ``BooleanArgument``.
+   Имя аргумента, указанное при создании `ValueArgument` или `BooleanArgument`.
 
 .. py:attribute:: value
 
-   Значение аргумента. Тип значения зависит от исходного класса аргумента:
-   
-   * Для ``BooleanArgument``: ``True`` если флаг был передан при запуске
-   * Для ``ValueArgument``: строка с переданным значением или значением по умолчанию
+   Значение аргумента. Тип зависит от исходного класса:
+
+* Для `BooleanArgument`: `True`, если флаг был передан.
+* Для `ValueArgument`: строка с переданным значением или значением по умолчанию
 
 .. py:attribute:: founder_class
 
-   Ссылка на класс, из которого был создан этот аргумент. Используется для определения типа аргумента и фильтрации в методе ``get_by_type()``.
+   Ссылка на класс-родитель. Используется для определения типа и фильтрации в методе `get_by_type()`.
 
 **Методы:**
 
 .. py:method:: __str__() -> str
 
-   Возвращает строковое представление аргумента в формате ``InputArgument(name=value)``.
+   Возвращает строковое представление в формате `InputArgument(name=value)`.
 
    .. code-block:: python
       :linenos:
@@ -198,4 +198,4 @@ InputArgument
 
 .. py:method:: __repr__() -> str
 
-   Возвращает техническое представление объекта в виде строки.
+   Возвращает техническое представление объекта.