Skip to content

Commit af0b548

Browse files
authored
docs: clarify that incomplete means "needs review" (#4268)
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.
1 parent f1af598 commit af0b548

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -670,7 +670,7 @@ The results of axe are grouped according to their outcome into the following arr
670670
- `passes`: These results indicate what elements passed the rules
671671
- `violations`: These results indicate what elements failed the rules
672672
- `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.
673-
- `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.
673+
- `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.
674674

675675
Each object returned in these arrays have the following properties:
676676

0 commit comments

Comments
 (0)