Skip to content

Commit aa09c83

Browse files
Add expanded docstring on uncertainty_type options
1 parent 821994a commit aa09c83

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/hist/intervals.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,11 @@ def ratio_uncertainty(
117117
num: Numerator or number of successes.
118118
denom: Denominator or number of trials.
119119
uncertainty_type: Coverage interval type to use in the calculation of
120-
the uncertainties.
121-
Default is ``"poisson"``.
120+
the uncertainties.
121+
``"poisson"`` (default) implements the Poisson interval for the
122+
numerator scaled by the denominator.
123+
``"poisson-ratio"`` implements the Clopper-Pearson interval for Poisson
124+
distributed ``num`` and ``denom``.
122125
123126
Returns:
124127
The uncertainties for the ratio.

0 commit comments

Comments
 (0)