oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Standardise docstring summary line placement.

Browse Source
This commit is contained in:
Marek Wolan
2023-07-07 10:28:00 +01:00
parent 653d76ec62
commit 5618283cc5
36 changed files with 350 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/primaite/transactions/transaction.py
View File

@@ -39,7 +39,8 @@ class Transaction(object):
"The env observation space description"
def as_csv_data(self) -> Tuple[List, List]:
"""Converts the Transaction to a csv data row and provides a header.
"""
Converts the Transaction to a csv data row and provides a header.
:return: A tuple consisting of (header, data).
"""
@@ -68,7 +69,8 @@ class Transaction(object):
def _turn_action_space_to_array(action_space) -> List[str]:
"""Turns action space into a string array so it can be saved to csv.
"""
Turns action space into a string array so it can be saved to csv.
:param action_space: The action space
:return: The action space as an array of strings
@@ -80,7 +82,8 @@ def _turn_action_space_to_array(action_space) -> List[str]:
def _turn_obs_space_to_array(obs_space, obs_assets, obs_features) -> List[str]:
"""Turns observation space into a string array so it can be saved to csv.
"""
Turns observation space into a string array so it can be saved to csv.
:param obs_space: The observation space
:param obs_assets: The number of assets (i.e. nodes or links) in the observation space