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

Improve LyntResult example #7

Open
saadq opened this issue May 17, 2018 · 0 comments
Open

Improve LyntResult example #7

saadq opened this issue May 17, 2018 · 0 comments
Labels
docs This issue is about adding or improving docs. good first issue Good for newcomers.

Comments

@saadq
Copy link
Owner

saadq commented May 17, 2018

The "LyntResult example" in the API docs currently just shows this:

{
  filePath: string
  errors: Array<{
    ruleName: string
    message: string
    line: number
    column: number
    endLine?: number
    endColumn?: number
  }>
  errorCount: number
  fixCount: number
}

Instead of just having the type, it would be nice to show an actual example of what a LyntResult object might look like.

@saadq saadq added good first issue Good for newcomers. docs This issue is about adding or improving docs. labels May 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is about adding or improving docs. good first issue Good for newcomers.
Projects
None yet
Development

No branches or pull requests

1 participant