Skip to content

Commit 3a90c85

Browse files
authored
Improve minos cl docstring (#1085)
Closes #1072
1 parent ba3d8ea commit 3a90c85

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

src/iminuit/minuit.py

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1501,14 +1501,17 @@ def minos(
15011501
Names of parameters to generate Minos errors for. If no positional
15021502
arguments are given, Minos is run for each parameter.
15031503
cl : float or None, optional
1504-
Confidence level of the interval. If not set or None, a standard 68 %
1505-
interval is computed (default). If 0 < cl < 1, the value is interpreted as
1506-
the confidence level (a probability). For convenience, values cl >= 1 are
1507-
interpreted as the probability content of a central symmetric interval
1508-
covering that many standard deviations of a normal distribution. For
1509-
example, cl=1 is interpreted as 68.3 %, and cl=2 is 84.3 %, and so on. Using
1510-
values other than 0.68, 0.9, 0.95, 0.99, 1, 2, 3, 4, 5 require the scipy
1511-
module.
1504+
Confidence level of the interval. If not set or None, a standard
1505+
interval is computed (default). A standard interval has about 68.3 %
1506+
confidence, which is the probability of being within one standard
1507+
deviation around the mean of a normal distribution. If 0 < cl < 1,
1508+
the value is interpreted as the confidence level (a probability).
1509+
For convenience, values cl >= 1 are interpreted as the probability
1510+
content of a central symmetric interval covering that many standard
1511+
deviations of a normal distribution. For example, cl=1 is
1512+
interpreted as about 68.3 %, and cl=2 as 84.3 %, and so on. Using
1513+
values other than 0.68, 0.9, 0.95, 0.99, 1, 2, 3, 4, 5 require the
1514+
scipy module.
15121515
ncall : int or None, optional
15131516
Limit the number of calls made by Minos. If None, an adaptive internal
15141517
heuristic of the Minuit2 library is used (Default: None).

0 commit comments

Comments
 (0)