From c13ce349b19567a68778b898d85040b48a0118ab Mon Sep 17 00:00:00 2001 From: Christian Oertlin Date: Tue, 27 Aug 2024 14:31:30 +0200 Subject: [PATCH] add docstring --- .../utils/sample_file_concatenation_formatter.py | 5 +++++ .../file_formatter_service/utils/sample_file_formatter.py | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/cg/services/file_delivery/file_formatter_service/utils/sample_file_concatenation_formatter.py b/cg/services/file_delivery/file_formatter_service/utils/sample_file_concatenation_formatter.py index 90cb27df7b..626ec274ee 100644 --- a/cg/services/file_delivery/file_formatter_service/utils/sample_file_concatenation_formatter.py +++ b/cg/services/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 index 83b90ffca4..c0dc2a1ed8 100644 --- 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