Skip to content

Commit ef3551b

Browse files
committed
Update docstrings
1 parent f6d0373 commit ef3551b

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

climada/hazard/forecast.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030

3131

3232
class HazardForecast(Forecast, Hazard):
33+
"""A hazard object with forecast information"""
3334

3435
def __init__(
3536
self,
@@ -47,8 +48,8 @@ def __init__(
4748
member : np.ndarray or None, optional
4849
Ensemble member identifiers as integers. Default is empty array.
4950
**hazard_kwargs
50-
keyword arguments to pass to Hazard.__init__. See Hazard.__init__
51-
docstring for details.
51+
keyword arguments to pass to :py:class:`~climada.hazard.base.Hazard` See
52+
py:meth`~climada.hazard.base.Hazard.__init__` for details.
5253
"""
5354
super().__init__(lead_time=lead_time, member=member, **hazard_kwargs)
5455

@@ -59,8 +60,12 @@ def from_hazard(cls, hazard: Hazard, lead_time: np.ndarray, member: np.ndarray):
5960
6061
Parameters
6162
----------
62-
hazard : Hazard
63+
hazard : climada.hazard.base.Hazard
6364
Hazard object to convert into a HazardForecast.
65+
lead_time : np.ndarray of np.datetime64 or None, optional
66+
Forecast lead times. Default is empty array.
67+
member : np.ndarray or None, optional
68+
Ensemble member identifiers as integers. Default is empty array.
6469
6570
Returns
6671
-------

0 commit comments

Comments
 (0)