update to outcomes documentation

quaquel · quaquel · commit 61c4aa016154 · 2022-09-24T12:50:35.000+02:00
resolves the documentation part of #168
diff --git a/ema_workbench/em_framework/outcomes.py b/ema_workbench/em_framework/outcomes.py
@@ -343,7 +343,7 @@ def from_disk(cls, filename, archive):
 
 
 class ArrayOutcome(AbstractOutcome):
-    """Array Outcome class for n-dimensional collections
+    """Array Outcome class for n-dimensional arrays
 
     Parameters
     ----------
@@ -433,7 +433,7 @@ def from_disk(cls, filename, archive):
 
 class TimeSeriesOutcome(ArrayOutcome):
     """
-    TimeSeries Outcome class
+    TimeSeries Outcome class for 1D arrays
 
     Parameters
     ----------
@@ -461,6 +461,12 @@ class TimeSeriesOutcome(ArrayOutcome):
     shape : tuple
     expected_range : tuple
 
+    Notes
+    -----
+    Time series outcomes are currently assumed to be 1D arrays. If you
+    are dealing with higher dimensional outputs (e.g., multiple replications
+    resulting in 2D arrays), use ArrayOutcome instead.
+
     """
 
     def __init__(self, name, variable_name=None, function=None, expected_range=None, shape=None):
