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.

Sign up for GitHub

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

Jump to bottom

Document failureSummary #4223

Open
Certary opened this issue Oct 28, 2023 · 2 comments
Open

Document failureSummary #4223

Certary opened this issue Oct 28, 2023 · 2 comments
Labels
docs Documentation changes

Comments

@Certary
Copy link

Certary commented Oct 28, 2023

Product

axe-core

Description

The output of the axe.run command sometimes includes a failureSummary for a node in the nodes array. This field is not document anywhere however.
@Certary Certary added docs Documentation changes ungroomed Ticket needs a maintainer to prioritize and label labels Oct 28, 2023
@straker
Copy link
Contributor

straker commented Oct 30, 2023 •
edited
Loading

Thanks for the issue. We can probably add a note to the result array section of the api docs that documents that failureSummary is only for nodes in the violations array.

@straker straker removed the ungroomed Ticket needs a maintainer to prioritize and label label Oct 30, 2023
@Certary
Copy link
Author

Certary commented Oct 31, 2023

This field is not only present for nodes in the violations array, but also the incomplete array. See #1972.

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

No branches or pull requests
2 participants
@straker @Certary