Add docstrings, simplify some plotting/metrics methods signatures

src/core/models/all_rainfall.py

@@ -331,6 +331,10 @@ def bar_rainfall_averages(
 
         :param monthly: if True, plots monthly rainfall averages.
         if False, plots seasonal rainfall averages.
+        :param begin_year: An integer representing the year
+        to start getting our rainfall values.
+        :param end_year: An integer representing the year
+        to end getting our rainfall values (optional).
         :return: A list of the Rainfall averages for each month or season.
         """
         label: str = f"Average rainfall (mm) between {begin_year or self.starting_year} and {self.get_last_year()}"

src/core/utils/functions/metrics.py

@@ -17,7 +17,7 @@ def get_average_rainfall(yearly_rainfall: pd.DataFrame, round_precision=2) -> fl
     Computes Rainfall average.
 
     :param yearly_rainfall: A pandas DataFrame displaying rainfall data (in mm) according to year.
-    :param round_precision: A float representing the rainfall precision (optional).
+    :param round_precision: A float representing the rainfall precision (optional). Defaults to 2.
     :return: A float representing the average Rainfall.
     """
     nb_years: int = len(yearly_rainfall)
@@ -68,7 +68,7 @@ def get_normal(yearly_rainfall: pd.DataFrame, begin_year, round_precision=2) ->
 
     :param yearly_rainfall: A pandas DataFrame displaying rainfall data (in mm) according to year.
     :param begin_year: A year to start the time frame.
-    :param round_precision: A float representing the rainfall precision (optional).
+    :param round_precision: A float representing the rainfall precision (optional). Defaults to 2.
     :return: A float storing the normal.
     """
 

src/core/utils/functions/plotting.py

@@ -37,7 +37,7 @@ def plot_column_according_to_year(
 
 
 def scatter_column_according_to_year(
-    yearly_rainfall: pd.DataFrame, label: Label, display_label: bool = True
+    yearly_rainfall: pd.DataFrame, label: Label, display_label=True
 ) -> bool:
     """
     Scatter specified column data according to year.
@@ -88,7 +88,7 @@ def bar_column_according_to_year(yearly_rainfall: pd.DataFrame, label: Label) ->
 
 def bar_monthly_rainfall_averages(
     monthly_rainfalls: dict,
-    label: str | None = "Average rainfall (mm)",
+    label="Average rainfall (mm)",
     begin_year: int | None = None,
     end_year: int | None = None,
 ) -> list:
@@ -98,6 +98,7 @@ def bar_monthly_rainfall_averages(
     :param monthly_rainfalls: A list of instances of MonthlyRainfall.
     To be purposeful, all instances should have the same time frame in years.
     :param label: A string to use as a label for bar graphic. (optional)
+    Defaults to "Average rainfall (mm)".
     :param begin_year: An integer representing the year
     to start getting our rainfall values (optional).
     :param end_year: An integer representing the year
@@ -140,7 +141,7 @@ def bar_monthly_rainfall_linreg_slopes(monthly_rainfalls: dict) -> list:
 
 def bar_seasonal_rainfall_averages(
     seasonal_rainfalls: dict,
-    label: str | None = "Average rainfall (mm)",
+    label="Average rainfall (mm)",
     begin_year: int | None = None,
     end_year: int | None = None,
 ) -> list:
@@ -150,6 +151,7 @@ def bar_seasonal_rainfall_averages(
     :param seasonal_rainfalls: A list of instances of SeasonalRainfall.
     To be purposeful, all instances should have the same time frame in years.
     :param label: A string to use as a label for bar graphic. (optional)
+    Defaults to "Average rainfall (mm)".
     :param begin_year: An integer representing the year
     to start getting our rainfall values (optional).
     :param end_year: An integer representing the year