docs

docs/root/api/command/input_flag.rst

@@ -3,11 +3,11 @@
 InputFlag
 =========
 
-Объект ``InputFlag`` представляет собой сущность флага введённой команды. Он создаётся в результате парсинга пользовательского ввода и содержит информацию о распознанном флаге, включая его имя, префикс, введённое значение и статус валидации.
+Объект `InputFlag` представляет собой флаг, введённый пользователем. Он создаётся в результате обработки пользовательского ввода и содержит информацию о распознанном флаге: его имя, префикс, значение и статус валидации.
 
 .. seealso::
 
-   Документация по :ref:`Flag <root_api_command_flag>` — сущность флага, регистрируемого для последующей обработки.
+   Документация по :ref:`Flag <root_api_command_flag>` — класс для регистрации флага.
 
    Документация по :ref:`ValidationStatus <root_api_command_validation_status>` — статусы валидации флагов.
 
@@ -28,33 +28,34 @@ InputFlag
 
 Создаёт новый объект введённого флага.
 
-* ``name`` : Имя введённого флага (обязательный параметр)
-* ``prefix`` : Префикс флага. По умолчанию ``"--"``. Возможные значения: ``"-"``, ``"--"``, ``"---"``
-* ``input_value`` : Значение введённого флага. Может быть ``None`` если флаг не принимает значения
-* ``status`` : Статус валидации флага из перечисления ``ValidationStatus``
+* ``name``: Имя введённого флага.
+* ``prefix``: Префикс флага (``-``, ``--``, ``---``). По умолчанию ``--``.
+* ``input_value``: Значение, переданное с флагом. Может быть `None`.
+* ``status``: Статус валидации из перечисления `ValidationStatus`.
 
 .. warning ::
-   Экземпляры класса не предназначены для их прямого создания, они содержаться в контейнере :ref:`Response <root_api_response>`
+   Экземпляры этого класса не предназначены для прямого создания. Они содержатся в объекте :ref:`Response <root_api_response>`.
 
 **Атрибуты:**
 
 .. py:attribute:: name
    :no-index:
 
-   Имя введённого флага в виде строки.
+   Имя введённого флага.
 
 .. py:attribute:: prefix
    :no-index:
 
-   Префикс флага. Один из: ``"-"``, ``"--"``, ``"---"``.
+   Префикс флага: ``-``, ``--`` или ``---``.
 
 .. py:attribute:: input_value
 
-   Значение, переданное с флагом в командной строке. Может быть ``None`` для флагов без значений.
+   Значение, переданное с флагом. Может быть `None` для флагов без значений.
 
 .. py:attribute:: status
+   :no-index:
 
-   Статус валидации флага. Один из: ``ValidationStatus.VALID``, ``ValidationStatus.INVALID``, ``ValidationStatus.UNDEFINED``.
+   Статус валидации флага: `ValidationStatus.VALID`, `ValidationStatus.INVALID` или `ValidationStatus.UNDEFINED`.
 
 **Пример использования:**
 
@@ -76,11 +77,11 @@ string_entity
    @property
    string_entity(self) -> str
 
-Возвращает строковое представление флага в формате ``prefix + name``.
+Возвращает строковое представление флага в формате `prefix + name`.
 
 :return: Строковое представление флага
 
-Это свойство объединяет префикс и имя флага в единую строку, которая представляет, как флаг был введён в командной строке.
+Это свойство объединяет префикс и имя в строку, представляющую флаг так, как он был введён в командной строке.
 
 **Пример использования:**
 
@@ -101,9 +102,9 @@ __str__
 
    __str__(self) -> str
 
-Возвращает строковое представление введённого флага вместе с его значением.
+Возвращает строковое представление флага вместе с его значением.
 
-:return: Строка в формате ``флаг значение``
+:return: Строка в формате `флаг значение`.
 
 **Пример использования:**
 
@@ -121,9 +122,9 @@ __repr__
 
    __repr__(self) -> str
 
-Возвращает отладочное представление объекта введённого флага.
+Возвращает отладочное представление объекта.
 
-:return: Строка в формате ``InputFlag<prefix=..., name=..., value=..., status=...>``
+:return: Строка в формате `InputFlag<prefix=..., name=..., value=..., status=...>`.
 
 **Пример использования:**
 
@@ -141,13 +142,13 @@ __eq__
 
    __eq__(self, other: object) -> bool
 
-Сравнивает два введённых флага на равенство по их имени.
+Сравнивает два введённых флага на равенство по имени.
 
-:param other: Объект для сравнения
-:return: ``True``, если имена флагов совпадают, иначе ``False``
-:raises NotImplementedError: Если ``other`` не является экземпляром ``InputFlag``
+:param other: Объект для сравнения.
+:return: `True`, если имена флагов совпадают, иначе `False`.
+:raises NotImplementedError: Если `other` не является экземпляром `InputFlag`.
 
-Два введённых флага считаются равными, если их имена идентичны.
+Два введённых флага считаются равными, если их имена совпадают.
 
 **Пример использования:**