Docs: Clean up sort-vars (#7045)

eslint · Sep 3, 2016 · 52e8d9c · 52e8d9c
1 parent 4126f12
commit 52e8d9c
Showing 1 changed file with 6 additions and 8 deletions.
diff --git a/docs/rules/sort-vars.md b/docs/rules/sort-vars.md
@@ -7,7 +7,7 @@ When declaring multiple variables within the same block, some developers prefer
 This rule checks all variable declaration blocks and verifies that all variables are sorted alphabetically.
 The default configuration of the rule is case-sensitive.
 
-The following patterns are considered problems:
+Examples of **incorrect** code for this rule:
 
 ```js
 /*eslint sort-vars: "error"*/
@@ -19,7 +19,7 @@ var a, B, c;
 var a, A;
 ```
 
-The following patterns are not considered problems:
+Examples of **correct** code for this rule:
 
 ```js
 /*eslint sort-vars: "error"*/
@@ -52,15 +52,13 @@ var c, d, a, e;
 
 ## Options
 
-```
-"sort-vars": [<enabled>, { "ignoreCase": <boolean> }]
-```
+This rule has an object option:
 
-### `ignoreCase`
+* `"ignoreCase": true` (default `false`) ignores the case-sensitivity of the variables order
 
-When `true` the rule ignores the case-sensitivity of the variables order.
+### ignoreCase
 
-The following patterns are not considered problems:
+Examples of **correct** code for this rule with the `{ "ignoreCase": true }` option:
 
 ```js
 /*eslint sort-vars: ["error", { "ignoreCase": true }]*/