test_dataset documentation

src/test_dataset.py

@@ -11,22 +11,25 @@ this_file_dir = Path(__file__).parent
 
 
 @pytest.fixture
-def the_dataset():
+def the_dataset() -> Dataset:
     dataset = Dataset(this_file_dir / "../data/GamingStudy_data.csv")
     return dataset
 
 
 def test_load_Dataset_class():
+    """Tests if the dataset is successfully loaded."""
     dataset = Dataset(this_file_dir / "../data/GamingStudy_data.csv")
     assert type(dataset) == Dataset
     assert type(dataset.dataframe) == pd.DataFrame
 
 
 def test_get_dataframe(the_dataset: Dataset):
+    """Tests Dataset.get_dataframe()."""
     assert type(the_dataset.get_dataframe()) == pd.DataFrame
 
 
 def test_combined_anxiety_score(the_dataset: Dataset):
+    """Tests Dataset.get_combined_anxiety_score()."""
     dataframe = the_dataset.get_dataframe()
     anxiety_scores = the_dataset.get_combined_anxiety_score(dataframe)
     assert anxiety_scores.dtype == float
@@ -35,12 +38,14 @@ def test_combined_anxiety_score(the_dataset: Dataset):
 
 
 def test_get_is_narcissist_col(the_dataset: Dataset):
+    """Tests Dataset.get_is_narcissist_col()."""
     dataframe = the_dataset.get_dataframe()
     is_narcissist_row = the_dataset.get_is_narcissist_col(dataframe)
     assert is_narcissist_row.dtype == bool
 
 
 def test_preprocessed_dataframe(the_dataset: Dataset):
+    """Tests that the dataframe is preprocessed correctly."""
     dataframe = the_dataset.get_dataframe()
     columns_set = set(dataframe.columns)
     assert "League" not in columns_set
@@ -49,5 +54,6 @@ def test_preprocessed_dataframe(the_dataset: Dataset):
 
 
 def test_get_sorted_columns(the_dataset: Dataset):
+    """Tests Dataset.get_sorted_column()."""
     sorted_GAD1 = the_dataset.get_sorted_column("GAD1")
     assert sorted_GAD1.iloc[0] <= sorted_GAD1.iloc[-1]