doc: fix docstring to refer to average over scenario, not year

Breakthrough-Energy · May 27, 2020 · d17fea5 · d17fea5
1 parent c728c2b
commit d17fea5
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/postreise/analyze/generation/curtailment.py b/postreise/analyze/generation/curtailment.py
@@ -106,10 +106,10 @@ def calculate_curtailment_time_series(scenario, resources=None):
 
 
 def calculate_curtailment_percentage(scenario, resources=('solar', 'wind')):
-    """Calculate year-long average curtailment for selected resources.
+    """Calculate scenario-long average curtailment for selected resources.
     :param powersimdata.scenario.scenario.Scenario scenario: scenario instance.
     :param tuple/list/set resources: names of resources to analyze.
-    :return: (*float*) -- Average curtailment fraction over the year.
+    :return: (*float*) -- Average curtailment fraction over the scenario.
     """
     _check_scenario(scenario)
     _check_resources(resources)