kolo/Argenta
1
0
Fork 0
mirror of https://github.com/koloideal/Argenta.git synced 2026-06-10 18:15:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation and code snippets

Browse Source
This commit is contained in:
kolo
2025-12-02 11:31:24 +03:00
parent 7c20bf296b
commit eae8cdbb58
14 changed files with 80 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/root/api/command/flag.rst
+1 -1
View File
@@ -67,7 +67,7 @@ string_entity
@property
string_entity(self) -> str
Возвращает строковое представление флага в формате `prefix + name`.
Возвращает строковое представление флага в формате ``prefix + name``.
:return: Строковое представление флага
docs/root/api/command/input_flag.rst
+2 -2
View File
@@ -51,7 +51,7 @@ string_entity
@property
string_entity(self) -> str
Возвращает строковое представление флага в формате `prefix + name`.
Возвращает строковое представление флага в формате ``prefix + name``.
:return: Строковое представление флага
@@ -70,7 +70,7 @@ __str__
Возвращает строковое представление флага вместе с его значением.
:return: Строка в формате `флаг значение`.
:return: Строка в формате ``флаг значение``.
**Пример использования:**
docs/root/api/command/input_flags.rst
+4 -4
View File
@@ -83,10 +83,10 @@ add_flag
Добавляет введённый флаг в коллекцию.
:param flag: Флаг типа `InputFlag` для добавления.
:param flag: Флаг типа ``InputFlag`` для добавления.
:return: None.
Метод добавляет флаг в конец списка `flags`. Используется для динамического расширения коллекции.
Метод добавляет флаг в конец списка ``flags``. Используется для динамического расширения коллекции.
.. note::
Этот метод используется редко, так как `InputFlags` обычно создаётся автоматически. Однако он может быть полезен для тестирования или ручного создания коллекций.
@@ -109,7 +109,7 @@ add_flags
Добавляет в коллекцию список введённых флагов.
:param flags: Список флагов типа `InputFlag` для добавления.
:param flags: Список флагов типа ``InputFlag`` для добавления.
:return: None.
Метод расширяет коллекцию, добавляя в неё все флаги из переданного списка. Эффективен для пакетного добавления.
@@ -128,7 +128,7 @@ add_flags
Обработка всех флагов с проверкой статусов
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Пример демонстрирует итерацию по всем введённым флагам с проверкой их статусов валидации:
**Пример использования:**
.. literalinclude:: ../../../code_snippets/input_flags/snippet10.py
:linenos: