Standardise docstring summary line placement.

2023-07-07 10:28:00 +01:00
parent 86725064ec
commit f4b98542b6
36 changed files with 350 additions and 175 deletions
--- a/src/primaite/utils/session_output_reader.py
+++ b/src/primaite/utils/session_output_reader.py
@@ -7,7 +7,8 @@ import polars as pl


 def av_rewards_dict(av_rewards_csv_file: Union[str, Path]) -> Dict[int, float]:
-    """Read an average rewards per episode csv file and return as a dict.
+    """
+    Read an average rewards per episode csv file and return as a dict.

    The dictionary keys are the episode number, and the values are the mean reward that episode.