chore: make evaluation_step description more explicit

Co-authored-by: Sasha <reallysasha@gmail.com>
instadeepai · Feb 23, 2024 · 8913c4d · 8913c4d
1 parent 9978930
commit 8913c4d
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/marl_eval/json_tools/json_logger.py b/marl_eval/json_tools/json_logger.py
@@ -82,12 +82,12 @@ def write(
         """Writes a step to the json reporting file.
 
         Args:
-            timestep (int): the current environment timestep
-            key (str): the metric that should be logged
-            value (str): the value of the metric that should be logged
-            evaluation_step (int): the evaluation step
+            timestep (int): the current environment timestep.
+            key (str): the name of the metric to be logged.
+            value (str): the value of the metric to be logged.
+            evaluation_step (int): the number of evaluations already run.
             is_absolute_metric (bool): whether the metric being logged is
-                an absolute metric
+                an absolute metric.
         """
 
         current_time = time.time()