docs: clarify axe.run options paramter does not modify rules or checks (

#3015) * docs: clarify axe.run options paramter does not modify rules or checks * Update doc/API.md Co-authored-by: Cassey Lottman <[email protected]> Co-authored-by: Cassey Lottman <[email protected]>
dequelabs · Jun 17, 2021 · ee17b67 · ee17b67
1 parent 4392bc0
commit ee17b67
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/doc/API.md b/doc/API.md
@@ -307,7 +307,7 @@ axe.run(context, options, (err, results) => {
 #### Parameters axe.run
 
 - [`context`](#context-parameter): (optional) Defines the scope of the analysis - the part of the DOM that you would like to analyze. This will typically be the `document` or a specific selector such as class name, ID, selector, etc.
-- [`options`](#options-parameter): (optional) Set of options passed into rules or checks, temporarily modifying them. This contrasts with `axe.configure`, which is more permanent.
+- [`options`](#options-parameter): (optional) Set of options that change how `axe.run` works, including what rules will run. To pass options to specific checks, use `axe.configure`.
 - [`callback`](#callback-parameter): (optional) The callback function which receives either null or an [error result](#error-result) as the first parameter, and the [results object](#results-object) when analysis is completed successfully, or undefined if it did not.
 
 ##### Context Parameter