docs: add docs for check options

[straker]

I only included checks whose options modified how the check behaved. Checks which used generic checks (such as non-empty-title) were not added to list as their options are not really there for the user to customize. Generic checks will be described in another doc about creating custom rules.

Note: I do not understand what all the options for p-as-heading do even from looking at the code. If anyone can provide that understanding that'd be great.

Rendered view https://github.com/dequelabs/axe-core/blob/62e559fd7c65b8f426d01d99803854b3b9dcef6c/doc/check-options.md

Closes issue: #2187

Reviewer checks

Required fields, to be filled out by PR reviewer(s)

• Follows the commit message policy, appropriate for next version
• Code is reviewed for security

[jeankaplansky]

RE: @straker's message above about not understanding all the options for p-as-heading - does https://dequeuniversity.com/rules/axe/3.5/p-as-heading clear it up for you?

Including a link to https://dequeuniversity.com/rules/axe rule help may be a valuable reference to other people. It can help people understand what a rule is supposed to do in addition to understanding why we check for one or more options.

[jeankaplansky]

something's wonky with the rendered codelisting formatting here:

[stephenmathieson]

Aside from it being hard to read (due to the tabs), I don't see anything "wonky" here.

[jeankaplansky]

It looks like a linter gone wild thing. The code itself looks fine. Github rendering, not so much.

[stephenmathieson]

I'm not sure what you're suggesting here. Is there anything that should be "fixed"?

[jeankaplansky]

@stephenmathieson: not if the 2 spaces = indentation/prettier stuff is working, no. It's up to Github to render it properly.

[stephenmathieson]

I do not understand.

[stephenmathieson]

While I think it's a good idea to document all of this, I fear that it's going to get out-of-date very quickly (and/or be a pain to maintain). Is there a way we could generate this document instead? Perhaps we could parse the JSDoc strings from the check code and build a .md file from them?

[jeankaplansky]

I think there's something to be gained by indicating what "kind of beast" the default values are - if they are CSS selectors, CSS properties on a selector, attribute values, ARIA-specific attr values. Anything that helps the end-user figure out what they're looking at and where it fits in the HTML context.

Resolved

[straker]

Table formatting is so much fun