Skip to content

Commit

Permalink
docs: change docstrings to class-level
Browse files Browse the repository at this point in the history
  • Loading branch information
Midnighter committed Aug 4, 2024
1 parent 83daa9b commit 17d2c34
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions src/taxpasta/application/sample_handling_application.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,19 @@


class SampleHandlingApplication:
"""Define the sample handling application."""
"""
Define the sample handling application.
Args:
profile_reader: A profile reader for a specific taxonomic profile format.
profile_standardiser: A profile standardisation service for a specific
taxonomic profile format.
taxonomy_service: A taxonomy service instance. It is assumed that all
profiles to be handled in the application are based on the given
taxonomy loaded in the service instance.
**kwargs: Passed on for inheritance.
"""

def __init__(
self,
Expand All @@ -61,19 +73,6 @@ def __init__(
taxonomy_service: TaxonomyService | None = None,
**kwargs: dict,
) -> None:
"""
Initialize the sample handling application.
Args:
profile_reader: A profile reader for a specific taxonomic profile format.
profile_standardiser: A profile standardisation service for a specific
taxonomic profile format.
taxonomy_service: A taxonomy service instance. It is assumed that all
profiles to be handled in the application are based on the given
taxonomy loaded in the service instance.
**kwargs: Passed on for inheritance.
"""
super().__init__(**kwargs)
self.reader = profile_reader
self.standardiser = profile_standardiser
Expand Down

0 comments on commit 17d2c34

Please sign in to comment.