Updated docstrings to be in line with the type hints added

kratman · Dec 23, 2023 · 6f50b40 · 6f50b40
1 parent fade900
commit 6f50b40
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/pybamm/experiment/experiment.py b/pybamm/experiment/experiment.py
@@ -22,17 +22,17 @@ class Experiment:
 
     Parameters
     ----------
-    operating_conditions : list
-        List of operating conditions
+    operating_conditions : list[str]
+        List of strings representing the operating conditions.
     period : string, optional
         Period (1/frequency) at which to record outputs. Default is 1 minute. Can be
         overwritten by individual operating conditions.
     temperature: float, optional
         The ambient air temperature in degrees Celsius at which to run the experiment.
         Default is None whereby the ambient temperature is taken from the parameter set.
         This value is overwritten if the temperature is specified in a step.
-    termination : list, optional
-        List of conditions under which to terminate the experiment. Default is None.
+    termination : list[str], optional
+        List of strings representing the conditions to terminate the experiment. Default is None.
         This is different from the termination for individual steps. Termination for
         individual steps is specified in the step itself, and the simulation moves to
         the next step when the termination condition is met