Skip to content

Confidence level docstring for minos #1072

@alexander-held

Description

@alexander-held

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions