From 00a1e11fc1e6c5d1d35227c4d2543dda6a4c1ffc Mon Sep 17 00:00:00 2001 From: kolo Date: Sat, 19 Apr 2025 12:13:29 +0300 Subject: [PATCH] new docs --- README2.md | 134 ++++------------------------------------------------- 1 file changed, 8 insertions(+), 126 deletions(-) diff --git a/README2.md b/README2.md index 69fd968..4842937 100644 --- a/README2.md +++ b/README2.md @@ -52,7 +52,7 @@ def main() -> None: if __name__ == '__main__': main() ``` -Пример оболочки с командой, у которой зарегистрированы флаги +Example TUI with a command that has processed flags ```python # routers.py @@ -96,7 +96,7 @@ def handler_with_flags(flags: InputFlags): ```python class AutoCompleter() ``` ---- + #### \_\_init\_\_ @@ -117,75 +117,11 @@ Public. Configures and implements auto-completion of input command None - - -#### complete - -```python -def complete(text, state) -> str | None -``` - -Private. Auto-completion function - -**Arguments**: - -- `text`: part of the command being entered -- `state`: the current cursor position is relative to the beginning of the line - -**Returns**: - -the desired candidate as str or None - - - -#### initial\_setup - -```python -def initial_setup(all_commands: list[str]) -> None -``` - -Public. Initial setup function - -**Arguments**: - -- `all_commands`: Registered commands for adding them to the autocomplete history - -**Returns**: - -None - - - -#### exit\_setup - -```python -def exit_setup() -> None -``` - -Public. Exit setup function - -**Returns**: - -None - - - -#### get\_history\_items - -```python -@staticmethod -def get_history_items() -> list[str] | list -``` - -Private. Returns a list of all commands entered by the user - -**Returns**: - -all commands entered by the user as list[str] +--- -# argenta.app.defaults +# `argenta.app.defaults` @@ -198,49 +134,11 @@ class PredefinedMessages() Public. A dataclass with predetermined messages for quick use +--- + -# argenta.app.dividing\_line.models - - - -## BaseDividingLine Objects - -```python -class BaseDividingLine(ABC) -``` - - - -#### \_\_init\_\_ - -```python -def __init__(unit_part: str = '-') -> None -``` - -Private. The basic dividing line - -**Arguments**: - -- `unit_part`: the single part of the dividing line - -**Returns**: - -None - - - -#### get\_unit\_part - -```python -def get_unit_part() -> str -``` - -Private. Returns the unit part of the dividing line - -**Returns**: - -unit_part of dividing line as str +# `argenta.app.dividing_line` @@ -269,23 +167,7 @@ Public. The static dividing line None - - -#### get\_full\_static\_line - -```python -def get_full_static_line(is_override: bool) -> str -``` - -Private. Returns the full line of the dividing line - -**Arguments**: - -- `is_override`: has the default text layout been redefined - -**Returns**: - -full line of dividing line as str +---