docs

docs/root/api/command/flag.rst

@@ -3,13 +3,13 @@
 Flag
 =====
 
-Объект ``Flag`` представляет собой сущность флага, регистрируемого для последующей обработки в приложении ``Argenta``. Его основная задача — определить параметры флага команды, включая имя, префикс и допустимые значения. ``Flag`` используется при создании команд с флагами и предоставляет механизм валидации входящих значений от пользователя.
+``Flag`` — это сущность, описывающая флаг команды. Её основная задача — определить параметры флага, включая его имя, префикс и правила валидации. `Flag` используется при создании команд и предоставляет механизм для проверки значений, введённых пользователем.
 
 .. seealso::
 
-   Документация по :ref:`PossibleValues <root_api_command_possible_values>` — сущность, определяющая допустимые значения флага.
+   Документация по :ref:`PossibleValues <root_api_command_possible_values>` — перечисление, определяющее типы допустимых значений.
    
-   Документация по :ref:`InputFlag <root_api_command_input_flag>` — объект распаршенного введённого флага.
+   Документация по :ref:`InputFlag <root_api_command_input_flag>` — объект обработанного флага, введённого пользователем.
    
    :ref:`Общая информация <root_flags>` о флагах и их использовании в приложении ``Argenta``
 
@@ -27,11 +27,11 @@ Flag
        possible_values: list[str] | Pattern[str] | PossibleValues = PossibleValues.ALL,
    ) -> None
 
-Создает новый флаг для регистрации в команде.
+Создаёт новый флаг для регистрации в команде.
 
-* ``name`` : Имя флага (обязательный параметр)
-* ``prefix`` : Префикс флага. По умолчанию ``"--"``. Возможные значения: ``"-"``, ``"--"``, ``"---"``
-* ``possible_values`` : Допустимые значения флага. По умолчанию ``PossibleValues.ALL``. Может быть списком строк, регулярным выражением или значением из enum ``PossibleValues``
+* ``name``: Имя флага (обязательный параметр).
+* ``prefix``: Префикс флага (``-``, ``--``, ``---``). По умолчанию ``--``.
+* ``possible_values``: Правила валидации значения. Может быть списком строк, регулярным выражением или значением из `PossibleValues`. По умолчанию `PossibleValues.ALL`.
 
 **Атрибуты:**
 
@@ -45,12 +45,12 @@ Flag
 
 .. py:attribute:: possible_values
 
-   Определяет допустимые значения для флага. Может быть:
-   
-   * Списком строк — флаг принимает только значения из этого списка
-   * Регулярным выражением (``Pattern[str]``) — значение проверяется на соответствие паттерну
-   * Значением ``PossibleValues.ALL`` — флаг принимает любое значение
-   * Значением ``PossibleValues.NEITHER`` — флаг не должен иметь значения
+   Определяет допустимые значения для флага:
+
+*   Список строк: флаг принимает только значения из этого списка.
+*   Регулярное выражение (`Pattern[str]`): значение проверяется на соответствие паттерну.
+*   `PossibleValues.ALL`: флаг принимает любое значение.
+*   `PossibleValues.NEITHER`: флаг не должен иметь значения.
 
 **Пример использования:**
 
@@ -72,11 +72,11 @@ string_entity
    @property
    string_entity(self) -> str
 
-Возвращает строковое представление флага в формате ``prefix + name``.
+Возвращает строковое представление флага в формате `prefix + name`.
 
 :return: Строковое представление флага
 
-Это свойство объединяет префикс и имя флага в единую строку, которая представляет, как флаг будет выглядеть в командной строке.
+Это свойство объединяет префикс и имя в единую строку, которая представляет флаг так, как он выглядел бы в командной строке.
 
 **Пример использования:**
 
@@ -97,7 +97,7 @@ __str__
 
    __str__(self) -> str
 
-Возвращает строковое представление флага (аналогично ``string_entity``).
+Возвращает строковое представление флага (аналогично `string_entity`).
 
 :return: Строковое представление флага
 
@@ -117,9 +117,9 @@ __repr__
 
    __repr__(self) -> str
 
-Возвращает отладочное представление объекта флага.
+Возвращает отладочное представление объекта.
 
-:return: Строка в формате ``Flag<prefix=..., name=...>``
+:return: Строка в формате `Flag<prefix=..., name=...>`.
 
 **Пример использования:**
 
@@ -137,13 +137,13 @@ __eq__
 
    __eq__(self, other: object) -> bool
 
-Сравнивает два флага на равенство по их строковому представлению.
+Сравнивает два флага на равенство по их строковому представлению (`string_entity`).
 
 :param other: Объект для сравнения
 :return: ``True``, если флаги равны, иначе ``False``
-:raises NotImplementedError: Если ``other`` не является экземпляром ``Flag``
+:raises NotImplementedError: Если `other` не является экземпляром `Flag`.
 
-Два флага считаются равными, если их ``string_entity`` идентичны.
+Два флага считаются равными, если их `string_entity` идентичны.
 
 **Пример использования:**
 
@@ -160,9 +160,9 @@ PredefinedFlags
 
 ``argenta.command.flag.defaults.PredefinedFlags``
 
-Класс ``PredefinedFlags`` предоставляет набор предопределенных флагов, которые можно использовать в приложениях без необходимости их ручного создания. Эти флаги покрывают наиболее распространенные сценарии использования и следуют общепринятым соглашениям командной строки.
+Класс `PredefinedFlags` предоставляет набор готовых флагов для использования в приложениях без их ручного создания. Эти флаги покрывают наиболее распространённые сценарии и следуют общепринятым соглашениям.
 
-Все предопределенные флаги являются атрибутами класса и представляют собой готовые экземпляры ``Flag``.
+Все предопределённые флаги являются атрибутами класса и представляют собой готовые экземпляры `Flag`.
 
 -----