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

[v1 reporter] Could 'failureSummary' be rendered for 'incomplete' audit results? #1971

Closed
jayaddison opened this issue Jan 7, 2020 · 1 comment
Milestone

Comments

@jayaddison
Copy link
Contributor

The axe-core v1 reporter adds a failureSummary field to each result in the list of audit violations (ref). This field contains human-readable help messaging to explain changes required to resolve the situation.

While making some changes in GoogleChrome/lighthouse#10072, I noticed that this field isn't present for results marked as incomplete (this was discovered via some test expectations (ref)).

Expectation: The list of incomplete results would contain a corresponding failureSummary field.

Actual: failureSummary is only populated for violations

Motivation: Assuming it's possible to populate the field for incomplete results, this field could be useful for client libraries to display help messaging to inform developers/designers on how to resolve potential accessibility issues.


axe-core version: 3.4.1
@jayaddison
Copy link
Contributor Author

Closing this as resolved by #1972 (my mistake for not using the correct PR description markdown to link the two issues).

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

No branches or pull requests

2 participants