market-data-sanity-checker - v1.2.0
    Preparing search index...

    Interface Finding

    interface Finding {
        rule: string;
        severity: Severity;
        action: RecommendedAction;
        dimension: QualityDimension;
        where?: Record<string, string | number>;
        explanation: string;
        evidence?: Record<string, unknown>;
        references?: string[];
        occurrences?: number;
    }
    Index
    rule: string

    Stable rule identifier, e.g. SPLIT_NOT_ADJUSTED.

    severity: Severity
    dimension: QualityDimension
    where?: Record<string, string | number>

    Where in the dataset the problem lives (e.g. { date: '2024-06-03' }).

    explanation: string

    Human-readable explanation with the causal hypothesis and the evidence behind it.

    evidence?: Record<string, unknown>
    references?: string[]

    URLs to the real-world incident or literature justifying the rule's threshold.

    occurrences?: number

    How many times this rule fired; a rule reports once per dataset.