Skip to content

Commit 102f9be

Browse files
committed
Update docstrings
1 parent 0aad2a5 commit 102f9be

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

climada/engine/impact_forecast.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,10 @@ def _reduce_attrs(self, reduce_method: str):
191191
Reduce the attributes of an ImpactForecast to a single value.
192192
193193
Attributes are modified as follows:
194-
- event_id: set to [0]
195-
- event_name: set to [reduce_method]
194+
- lead_time: set to NaT
195+
- member: set to -1
196+
- event_id: set to 0
197+
- event_name: set to reduce_method
196198
- date: set to the minimum value
197199
- frequency: set to 1
198200
@@ -223,7 +225,8 @@ def min(self):
223225
224226
Returns
225227
-------
226-
None
228+
ImpactForecast
229+
An ImpactForecast object with the min impact matrix and at_event.
227230
"""
228231
red_imp_mat = sparse.csr_matrix(self.imp_mat.min(axis=0))
229232
red_at_event = np.array([red_imp_mat.sum()])
@@ -258,7 +261,8 @@ def max(self):
258261
259262
Returns
260263
-------
261-
None
264+
ImpactForecast
265+
An ImpactForecast object with the max impact matrix and at_event.
262266
"""
263267
red_imp_mat = sparse.csr_matrix(self.imp_mat.max(axis=0))
264268
red_at_event = np.array([red_imp_mat.sum()])
@@ -295,7 +299,8 @@ def mean(self):
295299
296300
Returns
297301
-------
298-
None
302+
ImpactForecast
303+
An ImpactForecast object with the mean impact matrix and at_event.
299304
"""
300305
red_imp_mat = sparse.csr_matrix(self.imp_mat.mean(axis=0))
301306
red_at_event = np.array([red_imp_mat.sum()])

0 commit comments

Comments
 (0)