Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs Bug] FormatterOptions properties are not updated in documentation #2820

Closed
sarvaje opened this issue Aug 15, 2019 · 0 comments · Fixed by #2833

Comments

@sarvaje
Copy link
Member

commented Aug 15, 2019

The documentation is here: https://webhint.io/docs/contributor-guide/how-to/formatter/

the current FormatterOptions is:

export type FormatterOptions = {
    config?: UserConfig;
    /** Start time (queued in online scanner) ISO string */
    date?: string;
    isScanner?: boolean;
    /** Language used for localization */
    language?: string;
    noGenerateFiles?: boolean;
    /** The file to use to output the results requested by the user */
    output?: string;
    resources?: HintResources;
    /** The time it took to analyze the URL */
    scanTime?: number;
    status?: string;
    /** The analyzed URL */
    target?: string;
    /** webhint's version */
    version?: string;
};

@jaspreet57 jaspreet57 self-assigned this Aug 20, 2019

jaspreet57 added a commit to jaspreet57/hint that referenced this issue Aug 20, 2019

@antross antross added this to the 1908-2 milestone Aug 21, 2019

antross added a commit that referenced this issue Aug 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.