Standardise docstring summary line placement.
This commit is contained in:
@@ -10,7 +10,8 @@ _LOGGER = getLogger(__name__)
|
||||
|
||||
|
||||
def get_file_path(path: str) -> Path:
|
||||
"""Get PrimAITE package data.
|
||||
"""
|
||||
Get PrimAITE package data.
|
||||
|
||||
:Example:
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -77,7 +77,8 @@ class SessionOutputWriter:
|
||||
_LOGGER.debug(f"Finished writing file: {self._csv_file_path}")
|
||||
|
||||
def write(self, data: Union[Tuple, Transaction]):
|
||||
"""Write a row of session data.
|
||||
"""
|
||||
Write a row of session data.
|
||||
|
||||
:param data: The row of data to write. Can be a Tuple or an instance of Transaction.
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user