docs

docs/root/api/command/validation_status.rst

@@ -3,21 +3,21 @@
 ValidationStatus
 ================
 
-Enum ``ValidationStatus`` представляет собой перечисление, определяющее состояние валидации значений флагов в приложении ``Argenta``. Его основная задача — предоставить стандартизированные константы для отображения результата проверки введённых пользователем флагов и их значений. ``ValidationStatus`` используется в атрибуте ``status`` класса ``InputFlag`` для информирования о том, прошёл ли флаг валидацию успешно.
+`ValidationStatus` — это перечисление (`Enum`), которое определяет состояние валидации флага. Его задача — предоставить стандартные константы для отображения результата проверки. `ValidationStatus` используется в атрибуте `status` класса `InputFlag`, чтобы сообщить, прошла ли валидация успешно.
 
-``ValidationStatus`` наследуется от стандартного класса ``Enum`` и содержит три основных значения: ``VALID`` для корректных флагов, ``INVALID`` для некорректных флагов и ``UNDEFINED`` для незарегистрированных флагов.
+`ValidationStatus` наследуется от `Enum` и содержит три значения: `VALID` (корректный флаг), `INVALID` (некорректный) и `UNDEFINED` (незарегистрированный).
 
 .. note::
 
-   Статус валидации устанавливается автоматически при создании экземпляра ``InputFlag`` на основе проверки через соответствующий ``Flag``.
+   Статус валидации устанавливается автоматически при создании экземпляра `InputFlag` на основе правил, заданных в соответствующем `Flag`.
 
 .. seealso::
 
-   Документация по :ref:`InputFlag <root_api_command_input_flag>` — сущности входного флага, использующей ``ValidationStatus``
+   Документация по :ref:`InputFlag <root_api_command_input_flag>` — класс введённого флага, использующий `ValidationStatus`.
    
-   Документация по :ref:`Flag <root_api_command_flag>` — сущности флага с методом валидации
+   Документация по :ref:`Flag <root_api_command_flag>` — класс флага с правилами валидации.
    
-   Документация по :ref:`PossibleValues <root_api_command_possible_values>` — типам допустимых значений флагов
+   Документация по :ref:`PossibleValues <root_api_command_possible_values>` — типы допустимых значений.
 
 -----
 
@@ -32,16 +32,16 @@ VALID
 
    ValidationStatus.VALID = 'VALID'
 
-Указывает, что флаг и его значение **прошли** валидацию успешно.
+Указывает, что флаг и его значение **прошли** валидацию.
 
-Флаги с этим статусом полностью соответствуют правилам, заданным в параметре ``possible_values`` соответствующего ``Flag``. Такие флаги могут быть безопасно использованы в логике приложения без дополнительных проверок.
+Флаги с этим статусом соответствуют правилам, заданным в `possible_values` соответствующего `Flag`. Их можно безопасно использовать в логике приложения без дополнительных проверок.
 
 **Условия получения статуса** ``VALID``:
 
-* Флаг с ``PossibleValues.NEITHER`` передан без значения
-* Флаг с ``PossibleValues.ALL`` передан с любым значением или без него
-* Флаг со списком значений передан с одним из допустимых значений
-* Флаг с регулярным выражением передан со значением, соответствующим паттерну
+*   Флаг с `PossibleValues.NEITHER` передан без значения.
+*   Флаг с `PossibleValues.ALL` передан с любым значением или без него.
+*   Значение флага входит в список разрешённых.
+*   Значение флага соответствует регулярному выражению.
 
 **Пример использования:**
 
@@ -61,14 +61,14 @@ INVALID
 
 Указывает, что флаг или его значение **не прошли** валидацию.
 
-Флаги с этим статусом нарушают правила, установленные в ``possible_values`` соответствующего ``Flag``. Такие флаги должны быть обработаны как ошибочные, и их использование может привести к некорректной работе приложения.
+Флаги с этим статусом нарушают правила, заданные в `possible_values` соответствующего `Flag`. Их следует обрабатывать как ошибочные.
 
 **Условия получения статуса** ``INVALID``:
 
-* Флаг с ``PossibleValues.NEITHER`` передан со значением
-* Флаг со списком значений передан с недопустимым значением
-* Флаг с регулярным выражением передан со значением, не соответствующим паттерну
-* Флаг требует значение, но передан без него (для определённых типов валидации)
+*   Флаг с `PossibleValues.NEITHER` передан со значением.
+*   Значение флага не входит в список разрешённых.
+*   Значение флага не соответствует регулярному выражению.
+*   Флаг требует значение, но передан без него.
 
 **Пример использования:**
 
@@ -86,11 +86,11 @@ UNDEFINED
 
    ValidationStatus.UNDEFINED = 'UNDEFINED'
 
-Указывает, что флаг был введён, но не зарегистрирован.
+Указывает, что введённый флаг не был зарегистрирован в команде.
 
 **Условия получения статуса** ``UNDEFINED``:
 
-* Флаг был введён с любым значением, но не зарегистрирован
+*   Введённый флаг не найден среди зарегистрированных для данной команды.
 
 -----
 
@@ -101,7 +101,7 @@ UNDEFINED
 Комплексный пример валидации
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Пример демонстрирует использование всех статусов в реальном сценарии:
+Пример демонстрирует использование всех статусов в реальном сценарии.
 
 .. literalinclude:: ../../../code_snippets/validation_status/comprehensive.py
    :linenos: