docs: add reviewOnFail (#2429)

dequelabs · Jul 30, 2020 · da080b5 · da080b5
1 parent a804253
commit da080b5
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/doc/check-options.md b/doc/check-options.md
@@ -4,6 +4,7 @@
 
 - [How Checks Work](#how-checks-work)
 - [Options](#options)
+  - [Global Options](#global-options)
   - [aria-allowed-role](#aria-allowed-role)
   - [aria-required-children](#aria-required-children)
   - [aria-roledescription](#aria-roledescription)
@@ -56,6 +57,14 @@ axe.configure({
 
 ## Options
 
+### Global Options
+
+All checks allow these global options:
+
+| Option         | Default | Description                                                     |
+| -------------- | :------ | :-------------------------------------------------------------- |
+| `reviewOnFail` | `false` | Have the check return as "Needs Review" rather than a violation |
+
 ### aria-allowed-role
 
 | Option          | Default | Description                                                       |
@@ -123,7 +132,7 @@ axe.configure({
   'menuitemradio'
 ]</code></pre>
         </td>
-      <td align="left">List of ARIA roles that support the `aria-roledescription` attribute</td>
+      <td align="left">List of ARIA roles that support the <code>aria-roledescription</code> attribute</td>
     </tr>
   </tbody>
 </table>