Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation around options and defaults #140

Open
josebolos opened this issue Jun 2, 2021 · 0 comments
Open

Improve documentation around options and defaults #140

josebolos opened this issue Jun 2, 2021 · 0 comments

Comments

@josebolos
Copy link
Member

The global options concurrency and useIncognitoBrowserContext are mentioned in passing in the Default configuration section of the README. For someone not familiar with pa11y this makes it look as if these options are part of the defaults that apply to each one of the tests, but they are instead global options exclusive to pa11y-ci.

We probably need to change the order of these options and add first a section with pa11y-ci's options, and then a second section or subsection dealing with specifying defaults for the tests.

Environment:

$ pa11y-ci -V
2.4.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants