Skip to content

Commit

Permalink
docs: clarify that incomplete means "needs review" (#4268)
Browse files Browse the repository at this point in the history
When hearing the term "needs review" we don't make it clear in our docs that what we really mean is the `incomplete` results. Adding a bit of text to make sure it's clearly stated.
  • Loading branch information
straker authored Dec 11, 2023
1 parent f1af598 commit af0b548
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,7 @@ The results of axe are grouped according to their outcome into the following arr
- `passes`: These results indicate what elements passed the rules
- `violations`: These results indicate what elements failed the rules
- `inapplicable`: These results indicate which rules did not run because no matching content was found on the page. For example, with no video, those rules won't run.
- `incomplete`: These results were aborted and require further testing. This can happen either because of technical restrictions to what the rule can test, or because a javascript error occurred.
- `incomplete`: Also known as "needs review," these results were aborted and require further testing. This can happen either because of technical restrictions to what the rule can test, or because a javascript error occurred.

Each object returned in these arrays have the following properties:

Expand Down

0 comments on commit af0b548

Please sign in to comment.