diff --git a/logger/modules/log_file_merger.py b/logger/modules/log_file_merger.py index 59e5f96..c991553 100644 --- a/logger/modules/log_file_merger.py +++ b/logger/modules/log_file_merger.py @@ -15,6 +15,8 @@ def merge_log_files(log_file_directory: str) -> None: """ Reads, sorts, and writes log files in the specified directory. + + log_file_directory: The directory containing the log files to be merged. """ # Read log files log_files = [ @@ -38,7 +40,7 @@ def merge_log_files(log_file_directory: str) -> None: def get_current_run_directory() -> str: """ - Gets directory of current run. + Returns directory of current run. """ # Configuration settings result, config = read_yaml.open_config(CONFIG_FILE_PATH) diff --git a/logger/test_log_file_merger.py b/logger/test_log_file_merger.py index 8767f88..44bb32a 100644 --- a/logger/test_log_file_merger.py +++ b/logger/test_log_file_merger.py @@ -14,7 +14,7 @@ @pytest.fixture(name="dummy_logs") def fixture_dummy_logs() -> str: # type: ignore """ - Creates a temporary directory with dummy log files. + Returns the path to a temporary directory with dummy log files. """ temp_directory = tempfile.mkdtemp() subdirectory = os.path.join(temp_directory, "subdirectory")