@eagleoutice/flowr - v2.16.3
    Preparing search index...

    Interface DocumentationMismatchResult

    A linting result of a cmd-check rule.

    interface DocumentationMismatchResult {
        certainty: LintingResultCertainty;
        function?: string;
        involvedId: NodeId | NodeId[] | undefined;
        kind: DocumentationMismatchKind;
        loc: [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ];
        message: string;
        name: string;
        quickFix?: LintQuickFix[];
        rdFile?: string;
    }

    Hierarchy (View Summary)

    Index
    certainty function? involvedId kind loc message name quickFix? rdFile?
    certainty: LintingResultCertainty

    The certainty of the linting result.

    function?: string
    involvedId: NodeId | NodeId[] | undefined

    The node ID or IDs involved in this linting result, if applicable.

    kind: DocumentationMismatchKind
    loc: [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ]

    The source location where this linting result occurs

    message: string
    name: string
    quickFix?: LintQuickFix[]

    If available, what to do to fix the linting result.

    rdFile?: string

    Settings
    Member Visibility

    On This Page
    Properties