mirror of
https://github.com/koloideal/Argenta.git
synced 2026-06-10 18:15:28 +03:00
Update documentation and code snippets
This commit is contained in:
+11
-6
@@ -1,7 +1,7 @@
|
||||
.. _root_flags:
|
||||
|
||||
Флаги команд
|
||||
============
|
||||
Флаги вводимых команд
|
||||
=====================
|
||||
|
||||
Флаги — это специальные параметры, которые пользователь может добавлять к командам для управления их поведением.
|
||||
|
||||
@@ -60,9 +60,9 @@
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
greet --name John # Flag with value
|
||||
deploy --verbose # Flag without value (switch)
|
||||
backup -f --compress # Several flags
|
||||
greet --name John
|
||||
deploy --verbose
|
||||
backup -f --compress
|
||||
|
||||
-----
|
||||
|
||||
@@ -91,7 +91,12 @@
|
||||
Два типа флагов
|
||||
---------------
|
||||
|
||||
Флаги бывают двух основных видов: без значений (переключатели) и со значениями. ``Argenta`` позволяет регистрировать и вводить флаги обоих типов в любой последовательности для одной команды.
|
||||
Флаги бывают двух основных видов:
|
||||
|
||||
1. **Флаги со значениями** — принимают параметр после имени флага (например, ``--name John``, ``--port 8080``)
|
||||
2. **Флаги-переключатели** — не принимают значения, их наличие само по себе является сигналом (например, ``--verbose``, ``--force``)
|
||||
|
||||
``Argenta`` позволяет регистрировать и вводить флаги обоих типов в любой последовательности для одной команды.
|
||||
|
||||
.. note::
|
||||
Ошибки валидации не выбрасывают исключений. Вместо этого у каждого объекта :ref:`InputFlag <root_api_command_input_flag>` есть атрибут ``status``, по которому можно определить, прошла ли валидация успешно. Подробное описание API для создания флагов находится в разделе :ref:`Flag <root_api_command_flag>`.
|
||||
|
||||
Reference in New Issue
Block a user