Skip to content

Commit

Permalink
Update documentation for HTMLCS-only configurations
Browse files Browse the repository at this point in the history
  • Loading branch information
rowanmanning committed Oct 23, 2018
1 parent 8540217 commit 82e957b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Usage: pa11y [options] <url>
-V, --version output the version number
-n, --environment output details about the environment Pa11y will run in
-s, --standard <name> the accessibility standard to use: Section508, WCAG2A, WCAG2AA (default), WCAG2AAA
-s, --standard <name> the accessibility standard to use: Section508, WCAG2A, WCAG2AA (default), WCAG2AAA – only used by htmlcs runner
-r, --reporter <reporter> the reporter to use: cli (default), csv, json
-e, --runner <runner> the test runners to use: htmlcs (default), axe
-l, --level <level> the level of issue to fail on (exit with code 2): error, warning, notice
Expand All @@ -104,7 +104,7 @@ Usage: pa11y [options] <url>
-w, --wait <ms> the time to wait before running tests in milliseconds
-d, --debug output debug messages
-S, --screen-capture <path> a path to save a screen capture of the page to
-A, --add-rule <rule> WCAG 2.0 rules to include, a repeatable value or separated by semi-colons
-A, --add-rule <rule> WCAG 2.0 rules to include, a repeatable value or separated by semi-colons – only used by htmlcs runner
-h, --help output usage information
```

Expand Down Expand Up @@ -591,7 +591,7 @@ Defaults to:

### `rules` (array)

An array of WCAG 2.0 guidelines that you'd like to include to the current standard. Note: These won't be applied to `Section508` standard. You can find the codes for each guideline in the [HTML Code Sniffer WCAG2AAA ruleset][htmlcs-wcag2aaa-ruleset].
An array of WCAG 2.0 guidelines that you'd like to include to the current standard. Note: These won't be applied to `Section508` standard. You can find the codes for each guideline in the [HTML Code Sniffer WCAG2AAA ruleset][htmlcs-wcag2aaa-ruleset]. **Note:** only used by htmlcs runner.

```js
pa11y('http://example.com/', {
Expand All @@ -615,7 +615,7 @@ Defaults to `null`, meaning the screen will not be captured.

### `standard` (string)

The accessibility standard to use when testing pages. This should be one of `Section508`, `WCAG2A`, `WCAG2AA`, or `WCAG2AAA`.
The accessibility standard to use when testing pages. This should be one of `Section508`, `WCAG2A`, `WCAG2AA`, or `WCAG2AAA`. **Note:** only used by htmlcs runner.

```js
pa11y('http://example.com/', {
Expand Down
4 changes: 2 additions & 2 deletions bin/pa11y.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ function configureProgram() {
)
.option(
'-s, --standard <name>',
'the accessibility standard to use: Section508, WCAG2A, WCAG2AA (default), WCAG2AAA'
'the accessibility standard to use: Section508, WCAG2A, WCAG2AA (default), WCAG2AAA – only used by htmlcs runner'
)
.option(
'-r, --reporter <reporter>',
Expand Down Expand Up @@ -87,7 +87,7 @@ function configureProgram() {
)
.option(
'-A, --add-rule <rule>',
'WCAG 2.0 rules to include, a repeatable value or separated by semi-colons',
'WCAG 2.0 rules to include, a repeatable value or separated by semi-colons – only used by htmlcs runner',
collectOptions,
[]
)
Expand Down

0 comments on commit 82e957b

Please sign in to comment.