[Docs Bug] Configuration of axe is wrong or misleading

[masi]

📚 Request documentation enhancements

Description

https://webhint.io/docs/user-guide/hints/hint-axe/#can-the-hint-be-configured

It says:

You can modify what rules or categories are executed via an options object that follows axe’s documentation.

Then an example follows that does not look at all like a real axe configuration. It is completely unclear how options can be passed to axe.

I am not even sure if options refers to the second parameter of the axe.run() method or all of them.

In particular I want to set the "exclude" options for a part of the page that is not accessible and cannot (sad but true) be fixed. For that I need to use the first parameter of axe.run(), which is called context.

https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter

[hxlnt]

Thanks for filing the issue. You're right--this is a docs bug. We don't currently support passing the axe configuration. However, we'll fix the docs and open a new bug to track excluding part of the page as a feature request.