Skip to content

Commit de7fc0d

Browse files
include attribute in class docstrings
1 parent c61b780 commit de7fc0d

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

climada/hazard/storm_europe.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,11 @@ class StormEurope(Hazard):
8585
values only.
8686
ssi : np.array, float
8787
SSI as set by set_ssi; uses the Dawkins definition by default.
88+
89+
Class Attributes
90+
----------------
91+
intensity_thres : float
92+
Threshold below which wind speeds (in m/s) are stored as 0. Defaults to 14.6.
8893
"""
8994

9095
intensity_thres = DEF_INTENSITY_THRES

climada/hazard/trop_cyclone/trop_cyclone.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,11 @@ class TropCyclone(Hazard):
8888
For each event, the full velocity vectors at each centroid and track position in a sparse
8989
matrix of shape (npositions, ncentroids * 2) that can be reshaped to a full ndarray of
9090
shape (npositions, ncentroids, 2).
91+
92+
Class Attributes
93+
----------------
94+
intensity_thres : float
95+
Threshold below which wind speeds (in m/s) are stored as 0. Defaults to 17.5.
9196
"""
9297

9398
intensity_thres = DEF_INTENSITY_THRES

0 commit comments

Comments
 (0)