{"action":"closed","issue":{"url":"https://api.github.com/repos/dequelabs/axe-core/issues/70","labels_url":"https://api.github.com/repos/dequelabs/axe-core/issues/70/labels{/name}","comments_url":"https://api.github.com/repos/dequelabs/axe-core/issues/70/comments","events_url":"https://api.github.com/repos/dequelabs/axe-core/issues/70/events","html_url":"https://github.com/dequelabs/axe-core/issues/70","id":95972356,"number":70,"title":"documentation around `rules`","user":{"login":"jasonkarns","id":119972,"avatar_url":"https://avatars.githubusercontent.com/u/119972?v=3","gravatar_id":"","url":"https://api.github.com/users/jasonkarns","html_url":"https://github.com/jasonkarns","followers_url":"https://api.github.com/users/jasonkarns/followers","following_url":"https://api.github.com/users/jasonkarns/following{/other_user}","gists_url":"https://api.github.com/users/jasonkarns/gists{/gist_id}","starred_url":"https://api.github.com/users/jasonkarns/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jasonkarns/subscriptions","organizations_url":"https://api.github.com/users/jasonkarns/orgs","repos_url":"https://api.github.com/users/jasonkarns/repos","events_url":"https://api.github.com/users/jasonkarns/events{/privacy}","received_events_url":"https://api.github.com/users/jasonkarns/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/dequelabs/axe-core/labels/documentation","name":"documentation","color":"fef2c0"}],"state":"closed","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/dequelabs/axe-core/milestones/1","html_url":"https://github.com/dequelabs/axe-core/milestones/1.1.0","labels_url":"https://api.github.com/repos/dequelabs/axe-core/milestones/1/labels","id":1165403,"number":1,"title":"1.1.0","description":"","creator":{"login":"dsturley","id":421380,"avatar_url":"https://avatars.githubusercontent.com/u/421380?v=3","gravatar_id":"","url":"https://api.github.com/users/dsturley","html_url":"https://github.com/dsturley","followers_url":"https://api.github.com/users/dsturley/followers","following_url":"https://api.github.com/users/dsturley/following{/other_user}","gists_url":"https://api.github.com/users/dsturley/gists{/gist_id}","starred_url":"https://api.github.com/users/dsturley/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dsturley/subscriptions","organizations_url":"https://api.github.com/users/dsturley/orgs","repos_url":"https://api.github.com/users/dsturley/repos","events_url":"https://api.github.com/users/dsturley/events{/privacy}","received_events_url":"https://api.github.com/users/dsturley/received_events","type":"User","site_admin":false},"open_issues":2,"closed_issues":14,"state":"open","created_at":"2015-06-15T17:47:00Z","updated_at":"2015-07-20T13:53:43Z","due_on":null,"closed_at":null},"comments":2,"created_at":"2015-07-20T02:44:39Z","updated_at":"2015-07-20T13:53:43Z","closed_at":"2015-07-20T13:53:43Z","body":"The documentation around selecting which rules should be run (https://github.com/dequelabs/axe-core/blob/master/doc/API.md#b-options-parameter) lists essentially three modes of operation:\r\n1. only rules included in (presumably the union?) set of rules matching given tags\r\n2. run all rules except x, y, z\r\n3. run only rules x, y, z\r\n\r\nsyntax for 1. is `runOnly: type: \"tag\", values:[]`\r\nsyntax for 2. is `rules: rule1: enabled: false`\r\nsyntax for 3. is documented as `runOnly: type: \"rule\", values:[]`\r\n\r\nHowever, [example 3](https://github.com/dequelabs/axe-core/blob/master/doc/API.md#example-3) shows  `rules: rule1: enabled: true`. With the documented behavior being that only the rules listed as `enabled` are run. This seemingly contradicts the documentation which states that: \r\n> The default operation for a11yCheck is to run all rules.\r\n\r\nIs example 3 a typo? Should it have been `runOnly: type: \"rule\", values: [x, y, z]`? Or is the syntax truly `rules: rule1: enabled: true/false`. Or are both forms acceptable? If so, it sounds as if\r\n> The default operation for a11yCheck is to run all rules.\r\n\r\n should be clarified to state that once *any* `rules`/`runOnly` is specified, then a11yCheck no longer defaults to \"all rules\". (For if that were true, then specifying a list of rules with `enabled:true` would be meaningless.)"}}