Interface QueryDocumentation

interface QueryDocumentation {
    buildExplanation: (
        shell: RShell,
        ctx: GeneralDocContext,
    ) => Promise<string>;
    functionFile: string;
    functionName: string;
    name: string;
    shortDescription: string;
    type: "virtual" | "active";
}

Properties

buildExplanation: (shell: RShell, ctx: GeneralDocContext) => Promise<string>

functionFile: string

Path to the file implementing the query function, the wiki generation will fail if this isn't found

functionName: string

name: string

shortDescription: string

type: "virtual" | "active"