Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confidence level docstring for minos #1072

Open
alexander-held opened this issue Feb 2, 2025 · 1 comment
Open

Confidence level docstring for minos #1072

alexander-held opened this issue Feb 2, 2025 · 1 comment

Comments

@alexander-held
Copy link
Member

The docstring for cl in minos is

cl (float or None, optional) – Confidence level of the interval. If not set or None, a standard 68 % interval is computed (default). [...]

which to me sounds like it would by default compute a 68.00% confidence interval. It does however also say "standard" which might have different meanings to different people. The current behavior is that the default is equivalent to cl=1, corresponding to a 68.27% interval instead.

I propose to change the docstring to "68.27 %" to clarify this, happy to submit a PR if useful.

@HDembinski
Copy link
Member

If you feel strongly about that, feel free to submit a PR. Perhaps a more precise wording would be

..., a standard interval is computed (default). A standard interval has about 68.3 % confidence, analog to being within one standard deviation around the mean of a normal distribution.

The word about should make clear that this is an approximate number and the exact value is derived from the normal distribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants