Apply suggestions from code review

Co-authored-by: Henrik Stranneheim <[email protected]>

genotype_api/api/endpoints/analyses.py

@@ -58,7 +58,7 @@ def upload_sequence_analysis(
     session: Session = Depends(get_session),
     current_user: User = Depends(get_active_user),
 ):
-    """Reading vcf file, creating and uploading sequence analyses and sample objects to db."""
+    """Reading VCF file, creating and uploading sequence analyses and sample objects to the database."""
     analysis_service = AnalysisService(session)
     analyses: list[AnalysisResponse] = analysis_service.get_upload_sequence_analyses(file)
     return analyses

genotype_api/dto/analysis.py

@@ -1,4 +1,4 @@
-"""Module that holds the analysis dtos."""
+"""Module that holds the analysis DTOs."""
 
 from datetime import datetime
 

genotype_api/dto/genotype.py

@@ -1,4 +1,4 @@
-"""Module to hold the genotype dtos."""
+"""Module to hold the genotype DTOs."""
 
 from pydantic import BaseModel, Field
 

genotype_api/services/analysis_service/analysis_service.py

@@ -20,7 +20,7 @@
 
 
 class AnalysisService:
-    """This service acts as a translational layer between the crud and the api."""
+    """This service acts as a translational layer between the CRUD and the API."""
 
     def __init__(self, session: Session):
         self.session: Session = session
@@ -46,8 +46,7 @@ def get_analyses_to_display(self, skip: int, limit: int) -> list[AnalysisRespons
 
     def get_upload_sequence_analyses(self, file: UploadFile) -> list[AnalysisResponse]:
         """
-        Reading vcf file, creating and uploading sequence analyses and sample objects to db.
-        NOTE: requires further refactoring - leaving it for now.
+        Reading VCF file, creating and uploading sequence analyses and sample objects to the database.
         """
         file_name: Path = check_file(file_path=file.filename, extension=".vcf")
         content = file.file.read().decode("utf-8")