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

docs

Browse Source
This commit is contained in:
kolo
2025-11-21 21:09:29 +03:00
parent 2e76f68d4a
commit e5be7b5d99
5 changed files with 17 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/root/api/app/index.rst
+7 -7
View File
@@ -91,13 +91,13 @@ App
Устанавливает шаблон для форматирования описания команды.
Обработчик принимает триггер команды (``str``) и её описание (``str``), а возвращает отформатированную строку.
Обработчик принимает триггер команды (``str``) и её описание (``str``).
------
.. py:method:: set_incorrect_input_syntax_handler(self, handler: Callable[[str], None]) -> None
Устанавливает обработчик для некорректного синтаксиса флагов.
Устанавливает обработчик при некорректном введённом синтаксисе флагов.
Обработчик принимает строку, введённую пользователем.
@@ -105,7 +105,7 @@ App
.. py:method:: set_repeated_input_flags_handler(self, handler: Callable[[str], None]) -> None
Устанавливает обработчик для повторяющихся флагов в команде.
Устанавливает обработчик при повторяющихся флагах в введённой команде.
Обработчик принимает строку, введённую пользователем.
@@ -113,15 +113,15 @@ App
.. py:method:: set_unknown_command_handler(self, handler: Callable[[InputCommand], None]) -> None
Устанавливает обработчик для неизвестной команды.
Устанавливает обработчик при вводе неизвестной команды.
Обработчик принимает объект ``InputCommand``.
Обработчик принимает объект ``InputCommand`` - объект введённой команды.
-----
.. py:method:: set_empty_command_handler(self, handler: Callable[[], None]) -> None
Устанавливает обработчик для пустого ввода.
Устанавливает обработчик при вводе пустой строки.
Обработчик не принимает аргументов.
@@ -146,7 +146,7 @@ App
PredefinedMessages
------------------
`PredefinedMessages` — это перечисление (Enum), содержащее набор готовых к использованию строковых сообщений. Они отформатированы с использованием синтаксиса `rich` и предназначены для вывода стандартной информации, такой как подсказки по использованию.
``PredefinedMessages`` — это контейнер, содержащий набор готовых к использованию сообщений. Они отформатированы с использованием синтаксиса ``rich`` и предназначены для вывода стандартной информации, такой как подсказки по использованию.
Реккомендуется использовать их при старте приложения.