Added docstrings to class intialisers

src/primaite/utils/session_output_writer.py

@@ -12,7 +12,8 @@ _LOGGER: Logger = getLogger(__name__)
 
 
 class SessionOutputWriter:
-    """A session output writer class.
+    """
+    A session output writer class.
 
     Is used to write session outputs to csv file.
     """
@@ -28,6 +29,18 @@ class SessionOutputWriter:
         transaction_writer: bool = False,
         learning_session: bool = True,
     ):
+        """
+        Initialise the Session Output Writer.
+
+        :param env: PrimAITE gym environment.
+        :type env: Primaite
+        :param transaction_writer: If `true`, this will output a full account of every transaction taken by the agent.
+            If `false` it will output the average reward per episode, defaults to False
+        :type transaction_writer: bool, optional
+        :param learning_session: Set to `true` to indicate that the current session is a training session. This
+            determines the name of the folder which contains the final output csv. Defaults to True
+        :type learning_session: bool, optional
+        """
         self._env = env
         self.transaction_writer = transaction_writer
         self.learning_session = learning_session