added documentation, types

niradar · Jun 3, 2024 · 9a9269a · 9a9269a
1 parent d05863d
commit 9a9269a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/duplicate_files_in_folders/logging_config.py b/duplicate_files_in_folders/logging_config.py
@@ -4,6 +4,11 @@
 
 
 def setup_logging():
+    """
+    Setup logging for the script. Logs are saved in the logs folder. The log file is named log_<current_date_time>.txt
+    Only errors (and above) are logged to the console.
+    :return: None
+    """
     is_test = 'PYTEST_CURRENT_TEST' in os.environ
     formatter = logging.Formatter('[%(levelname)s]\t%(asctime)s:\t%(message)s')
     logger = logging.getLogger()