add docstring

Clinical-Genomics · Aug 27, 2024 · c13ce34 · c13ce34
1 parent 93056cd
commit c13ce34
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/...ervices/file_delivery/file_formatter_service/utils/sample_file_concatenation_formatter.py b/...ervices/file_delivery/file_formatter_service/utils/sample_file_concatenation_formatter.py
@@ -13,6 +13,11 @@
 
 
 class SampleFileConcatenationFormatter(SampleFileFormatter):
+    """
+    Format the sample files to deliver, concatenate fastq files and return the formatted files.
+    Used for workflows: Microsalt and Mutant.
+    """
+
     def __init__(self, concatenation_service: FastqConcatenationService):
         self.concatenation_service = concatenation_service
 

diff --git a/cg/services/file_delivery/file_formatter_service/utils/sample_file_formatter.py b/cg/services/file_delivery/file_formatter_service/utils/sample_file_formatter.py
@@ -5,6 +5,10 @@
 
 
 class SampleFileFormatter:
+    """
+    Format the sample files to deliver.
+    Used for all workflows except Microsalt and Mutant.
+    """
 
     def format_files(
         self, moved_files: list[SampleFile], ticket_dir_path: Path