Apply suggestions from code review

Co-authored-by: Lin Zhihao <[email protected]>

Author: haiqi96

components/clp-package-utils/clp_package_utils/general.py

@@ -495,11 +495,11 @@ def validate_results_cache_config(
     )
 
 
-def validate_logs_input_config(clp_config: CLPConfig):
+def validate_logs_input_config(clp_config: CLPConfig) -> None:
     clp_config.validate_logs_input_config()
 
 
-def validate_output_storage_config(clp_config: CLPConfig):
+def validate_output_storage_config(clp_config: CLPConfig) -> None:
     clp_config.validate_archive_output_config()
     clp_config.validate_stream_output_config()
 

components/job-orchestration/job_orchestration/garbage_collector/archive_garbage_collector.py

@@ -204,7 +204,6 @@ async def archive_garbage_collector(
     recovery_file = clp_config.logs_directory / f"{ARCHIVE_GARBAGE_COLLECTOR_NAME}.tmp"
 
     logger.info(f"{ARCHIVE_GARBAGE_COLLECTOR_NAME} started.")
-    # Start retention loop
     try:
         while True:
             _collect_and_sweep_expired_archives(

components/job-orchestration/job_orchestration/garbage_collector/search_result_garbage_collector.py

@@ -63,7 +63,7 @@ def _collect_and_sweep_expired_search_results(
             job_results_collection.drop()
             deleted_job_ids.append(int(job_id))
 
-    logger.debug(f"deleted search results of job(s): {deleted_job_ids}.")
+    logger.debug(f"Deleted search results of job(s): {deleted_job_ids}.")
 
 
 async def search_result_garbage_collector(

components/job-orchestration/job_orchestration/garbage_collector/utils.py

@@ -89,11 +89,12 @@ def execute_deletion(output_config: ArchiveOutput, deletion_candidates: Set[str]
 
 class DeletionCandidatesBuffer:
     """
-    A class representing an in-memory buffer for candidates with fault-tolerance support.
+    Represents an in-memory buffer for deletion candidates with fault-tolerance support.
 
-    This class support recovering from a previous failure by reading previously persisted candidates
-    from a recovery file. The user is expected to explicitly call `persists_new_candidates` to
-    persist any new candidates on to the disk for fault-tolerance purposes.
+    This class supports recovering from a previous failure by reading previously persisted
+    candidates from a recovery file. The user is expected to explicitly call
+    `persist_new_candidates` to persist any new candidates on to the disk for fault-tolerance
+    purposes.
 
     :param recovery_file_path: Path to the file used for recovering and persisting candidates.
     :raises ValueError: If the recovery path exists but is not a file.
@@ -137,10 +138,10 @@ def persist_new_candidates(self) -> None:
 
     def clear(self):
         """
-        Clear the in-memory buffer of candidates and remove the recovery file.
+        Clears the in-memory buffer of candidates and removes the recovery file.
 
-        This is intended to be called after the caller finished processing all candidates (i.e. when
-        recovery is no longer needed for the candidates.)
+        This is intended to be called after the caller finished processing all candidates (i.e.,
+        when recovery is no longer needed for the candidates.)
         """
         self._candidates.clear()
         if self._recovery_file_path.exists():