Skip to content

Commit 6910854

Browse files
committed
docs: update docstring for install_rogue_tui
1 parent 3b811eb commit 6910854

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

rogue/common/tui_installer.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,15 @@ def install_rogue_tui(
170170
upgrade: bool = False,
171171
reinstall: bool = False,
172172
) -> bool:
173-
"""Install rogue-tui from GitHub releases if not already installed."""
173+
"""Install rogue-tui from GitHub releases if not already installed.
174+
175+
Args:
176+
upgrade: Force upgrade even if already installed.
177+
reinstall: Force reinstallation even if already installed.
178+
179+
Returns:
180+
bool: True if installation succeeded, False otherwise.
181+
"""
174182
console = Console()
175183
# Check if rogue-tui is already available
176184
if self._is_rogue_tui_installed() and not upgrade and not reinstall:

0 commit comments

Comments
 (0)