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

Add all reporters to doc/API.md #1560

Closed
WilcoFiers opened this issue May 10, 2019 · 3 comments
Closed

Add all reporters to doc/API.md #1560

WilcoFiers opened this issue May 10, 2019 · 3 comments
Assignees
Labels
docs Documentation changes

Comments

@WilcoFiers
Copy link
Contributor

Expectation: All available reporters in axe-core are listed in the API docs.

Actual: only v1 and v2 are documented.

@straker
Copy link
Contributor

straker commented Jun 4, 2019

None of the reporters describe what they do exactly. Do you have a summary of them? Looking at the code this is my best guess:

  • raw to return the raw result data without formating: axe.configure({ reporter: "raw" });
  • raw-env to return the raw result data with environment data: axe.configure({ reporter: "raw-env" });
  • no-passes to return only violation results: axe.configure({ reporter: "no-passes" });
  • na (no idea what this reporter does)

@jeankaplansky
Copy link
Contributor

Doc is present and accounted for, but no one specifically validated @straker's best guess. @WilcoFiers, @JKODU? Did he guess right? I'm moving this ticket to QA in the meantime. Please make a new sprint-ready ticket for any required corrections for 7/1. Thanks!

@somaalapati
Copy link

Now rest of the 3 reporting types have been added to doc/API.md file. So, closing this ticket. (will close this after getting confirmation on expected details from @WilcoFiers.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation changes
Projects
None yet
Development

No branches or pull requests

4 participants