From 11513adf485720a72c41dff6846bbafbc384c093 Mon Sep 17 00:00:00 2001 From: furtest Date: Fri, 25 Jul 2025 12:02:25 +0200 Subject: [PATCH] Improves user_select_files documentation --- src/unisync/paths.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/unisync/paths.py b/src/unisync/paths.py index 5285446..8e66253 100644 --- a/src/unisync/paths.py +++ b/src/unisync/paths.py @@ -6,9 +6,13 @@ import subprocess def user_select_files(local_dir:str, choice_timeout:int=120) -> list[str]: """ Make the user select files in the top directory. - Currently uses nnn for the selection, - the goal is to replace it in order to avoid using external programs. - Returns the list of paths selected. + Currently uses nnn for the selection. + The goal is to replace it in order to avoid using external programs. + Args: + local_dir: The absolute path to the top synchronisation directory + choice_timeout: Time given to make choices in nnn + Returns: + list[str]: The list of paths that was selected """ command = [ "/usr/bin/nnn",