Skip to content

Better documentation for errordef #930

@iguinn

Description

@iguinn

Please document which cost functions require which values for errordef. For example, the ExtendedUnbinned cost function actually uses errordef=1, which was surprising to me since I was expecting it to act like a likelihood rather than a chi-square function (I actually think it's great, especially for beginners, that by default one does not need to set errordef for this). I would suggest adding a quick sentence to each cost function in the documentation telling people what to use for errordef (I looked at the actual implementation of the function to figure this out!)

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