docs: clarify axe.run options paramter does not modify rules or checks #3015
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clottman
reviewed
Jun 17, 2021
Co-authored-by: Cassey Lottman <[email protected]>
clottman
approved these changes
Jun 17, 2021
stephenmathieson
approved these changes
Jun 17, 2021
straker
added a commit
that referenced
this pull request
Jun 22, 2021
#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]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The docs implied that
axe.runcould change rules or check metadata (like passing a check option) when it doesn't. Changed it to not imply that.