Skip to content

Commit 27ac7ab

Browse files
committed
Clarify some docstrings
1 parent 4c10da0 commit 27ac7ab

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

climada/engine/unsequa/input_var.py

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -246,9 +246,8 @@ def haz(haz_list, n_ev=None, bounds_int=None, bounds_frac=None, bounds_freq=None
246246
The frequency of all events is multiplied by a number
247247
sampled uniformly from a distribution with (min, max) = bounds_freq
248248
HL: sample uniformly from hazard list
249-
From the provided list of hazard is elements are uniformly
250-
sampled. For example, Hazards outputs from dynamical models
251-
for different input factors.
249+
Uniformly sample one element from the provided list of hazards.
250+
For example, Hazards outputs from dynamical models for different input factors.
252251
253252
If a bounds is None, this parameter is assumed to have no uncertainty.
254253
@@ -310,8 +309,8 @@ def exp(exp_list, bounds_totval=None, bounds_noise=None):
310309
with (min, max) = bounds_noise. EN is the value of the seed
311310
for the uniform random number generator.
312311
EL: sample uniformly from exposure list
313-
From the provided list of exposure is elements are uniformly
314-
sampled. For example, LitPop instances with different exponents.
312+
Uniformly sample one element from the provided list of exposures.
313+
For example, LitPop instances with different exponents.
315314
316315
If a bounds is None, this parameter is assumed to have no uncertainty.
317316
@@ -376,9 +375,8 @@ def impfset(
376375
sampled uniformly from a distribution with
377376
(min, max) = bounds_int
378377
IL: sample uniformly from impact function set list
379-
From the provided list of impact function sets elements are uniformly
380-
sampled. For example, impact functions obtained from different
381-
calibration methods.
378+
Uniformly sample one element from the provided list of impact function sets.
379+
For example, impact functions obtained from different calibration methods.
382380
383381
384382
If a bounds is None, this parameter is assumed to have no uncertainty.
@@ -468,8 +466,8 @@ def ent(
468466
with (min, max) = bounds_noise. EN is the value of the seed
469467
for the uniform random number generator.
470468
EL: sample uniformly from exposure list
471-
From the provided list of exposure is elements are uniformly
472-
sampled. For example, LitPop instances with different exponents.
469+
Uniformly sample one element from the provided list of exposures.
470+
For example, LitPop instances with different exponents.
473471
MDD: scale the mdd (homogeneously)
474472
The value of mdd at each intensity is multiplied by a number
475473
sampled uniformly from a distribution with
@@ -483,9 +481,8 @@ def ent(
483481
sampled uniformly from a distribution with
484482
(min, max) = bounds_int
485483
IL: sample uniformly from impact function set list
486-
From the provided list of impact function sets elements are uniformly
487-
sampled. For example, impact functions obtained from different
488-
calibration methods.
484+
Uniformly sample one element from the provided list of impact function sets.
485+
For example, impact functions obtained from different calibration methods.
489486
490487
If a bounds is None, this parameter is assumed to have no uncertainty.
491488
@@ -566,7 +563,7 @@ def ent(
566563
bounds_noise=bounds_noise,
567564
exp_list=exp_list,
568565
meas_set=meas_set,
569-
**kwargs
566+
**kwargs,
570567
),
571568
_ent_unc_dict(
572569
bounds_totval=bounds_totval,
@@ -616,8 +613,8 @@ def entfut(
616613
with (min, max) = bounds_noise. EN is the value of the seed
617614
for the uniform random number generator.
618615
EL: sample uniformly from exposure list
619-
From the provided list of exposure is elements are uniformly
620-
sampled. For example, LitPop instances with different exponents.
616+
Uniformly sample one element from the provided list of exposures.
617+
For example, LitPop instances with different exponents.
621618
MDD: scale the mdd (homogeneously)
622619
The value of mdd at each intensity is multiplied by a number
623620
sampled uniformly from a distribution with
@@ -631,9 +628,8 @@ def entfut(
631628
sampled uniformly from a distribution with
632629
(min, max) = bounds_impfi
633630
IL: sample uniformly from impact function set list
634-
From the provided list of impact function sets elements are uniformly
635-
sampled. For example, impact functions obtained from different
636-
calibration methods.
631+
Uniformly sample one element from the provided list of impact function sets.
632+
For example, impact functions obtained from different calibration methods.
637633
638634
If a bounds is None, this parameter is assumed to have no uncertainty.
639635
@@ -706,7 +702,7 @@ def entfut(
706702
impf_set_list=impf_set_list,
707703
exp_list=exp_list,
708704
meas_set=meas_set,
709-
**kwargs
705+
**kwargs,
710706
),
711707
_entfut_unc_dict(
712708
bounds_eg=bounds_eg,

0 commit comments

Comments
 (0)