Merge pull request #3866 from eslint/issue2271

Docs: Prepare for rule doc linting (refs #2271)

docs/rules/array-bracket-spacing.md

@@ -4,6 +4,8 @@ A number of style guides require or disallow spaces between array brackets. This
 applies to both array literals and destructuring assignment (EcmaScript 6) using arrays.
 
 ```js
+/*eslint-env es6*/
+
 var arr = [ 'foo', 'bar' ];
 var [ x, y ] = z;
 
@@ -39,6 +41,7 @@ When `"never"` is set, the following patterns are considered problems:
 
 ```js
 /*eslint array-bracket-spacing: [2, "never"]*/
+/*eslint-env es6*/
 
 var arr = [ 'foo', 'bar' ];   /*error There should be no space after '['*/ /*error There should be no space before ']'*/
 var arr = ['foo', 'bar' ];                                                 /*error There should be no space before ']'*/
@@ -57,6 +60,7 @@ The following patterns are not considered problems:
 
 ```js
 /*eslint array-bracket-spacing: [2, "never"]*/
+/*eslint-env es6*/
 
 var arr = [];
 var arr = ['foo', 'bar', 'baz'];
@@ -82,6 +86,7 @@ When `"always"` is used, the following patterns are considered problems:
 
 ```js
 /*eslint array-bracket-spacing: [2, "always"]*/
+/*eslint-env es6*/
 
 var arr = ['foo', 'bar'];      /*error A space is required after '['*/ /*error A space is required before ']'*/
 var arr = ['foo', 'bar' ];     /*error A space is required after '['*/
@@ -103,6 +108,7 @@ The following patterns are not considered problems:
 
 ```js
 /*eslint array-bracket-spacing: [2, "always"]*/
+/*eslint-env es6*/
 
 var arr = [];
 var arr = [ 'foo', 'bar', 'baz' ];

docs/rules/arrow-parens.md

@@ -8,6 +8,8 @@ be wrapped in parentheses. This rule enforces the consistent use of parentheses
 This rule enforces parentheses around arrow function parameters regardless of arity. For example:
 
 ```js
+/*eslint-env es6*/
+
 // Bad
 a => {}
 
@@ -20,6 +22,8 @@ when a comparison such as `>=` was the intent.
 
 
 ```js
+/*eslint-env es6*/
+
 // Bad
 if (a => 2) {
 }
@@ -32,6 +36,8 @@ if (a >= 2) {
 The rule can also be configured to discourage the use of parens when they are not required:
 
 ```js
+/*eslint-env es6*/
+
 // Bad
 (a) => {}
 
@@ -53,6 +59,7 @@ When the rule is set to `"always"` the following patterns are considered problem
 
 ```js
 /*eslint arrow-parens: [2, "always"]*/
+/*eslint-env es6*/
 
 a => {};                     /*error Expected parentheses around arrow function argument.*/
 a => a;                      /*error Expected parentheses around arrow function argument.*/
@@ -66,6 +73,7 @@ The following patterns are not considered problems:
 
 ```js
 /*eslint arrow-parens: [2, "always"]*/
+/*eslint-env es6*/
 
 () => {};
 (a) => {};
@@ -80,6 +88,8 @@ a.then((foo) => { if (true) {}; });
 One benefits of this option is that it prevents the incorrect use of arrow functions in conditionals:
 
 ```js
+/*eslint-env es6*/
+
 var a = 1;
 var b = 2;
 // ...
@@ -95,6 +105,8 @@ The contents of the `if` statement is an arrow function, not a comparison.
 If the arrow function is intentional, it should be wrapped in parens to remove ambiguity.
 
 ```js
+/*eslint-env es6*/
+
 var a = 1;
 var b = 0;
 // ...
@@ -109,6 +121,8 @@ if ((a) => b) {
 The following is another example of this behavior:
 
 ```js
+/*eslint-env es6*/
+
 var a = 1, b = 2, c = 3, d = 4;
 var f = a => b ? c: d;
 // f = ?
@@ -119,6 +133,8 @@ var f = a => b ? c: d;
 This should be rewritten like so:
 
 ```js
+/*eslint-env es6*/
+
 var a = 1, b = 2, c = 3, d = 4;
 var f = (a) => b ? c: d;
 ```
@@ -130,6 +146,7 @@ When the rule is set to `"as-needed"` the following patterns are considered prob
 
 ```js
 /*eslint arrow-parens: [2, "as-needed"]*/
+/*eslint-env es6*/
 
 (a) => {};                     /*error Unexpected parentheses around single function argument*/
 (a) => a;                      /*error Unexpected parentheses around single function argument*/
@@ -143,6 +160,7 @@ The following patterns are not considered problems:
 
 ```js
 /*eslint arrow-parens: [2, "as-needed"]*/
+/*eslint-env es6*/
 
 () => {};
 a => {};

docs/rules/arrow-spacing.md

@@ -3,6 +3,8 @@
 This rule normalize style of spacing before/after an arrow function's arrow(`=>`).
 
 ```js
+/*eslint-env es6*/
+
 // { "before": true, "after": true }
 (a) => {}
 
@@ -24,6 +26,7 @@ The following patterns are considered problems if `{ "before": true, "after": tr
 
 ```js
 /*eslint arrow-spacing: 2*/
+/*eslint-env es6*/
 
 ()=> {};     /*error Missing space before =>*/
 () =>{};     /*error Missing space after =>*/
@@ -39,6 +42,7 @@ The following patterns are not considered problems if `{ "before": true, "after"
 
 ```js
 /*eslint arrow-spacing: 2*/
+/*eslint-env es6*/
 
 () => {};
 (a) => {};
@@ -50,6 +54,7 @@ The following patterns are not considered problems if `{ "before": false, "after
 
 ```js
 /*eslint arrow-spacing: [2, { "before": false, "after": false }]*/
+/*eslint-env es6*/
 
 ()=>{};
 (a)=>{};
@@ -61,6 +66,7 @@ The following patterns are not considered problems if `{ "before": true, "after"
 
 ```js
 /*eslint arrow-spacing: [2, { "before": true, "after": false }]*/
+/*eslint-env es6*/
 
 () =>{};
 (a) =>{};
@@ -72,6 +78,7 @@ The following patterns are not considered problems if `{ "before": false, "after
 
 ```js
 /*eslint arrow-spacing: [2, { "before": false, "after": true }]*/
+/*eslint-env es6*/
 
 ()=> {};
 (a)=> {};

docs/rules/block-scoped-var.md

@@ -35,7 +35,7 @@ function doSomething() {
 
 function doSomething() {
     if (true) {
-        var build = true;
+        var build = true;  /*error "build" used outside of binding context.*/
     } else {
         var build = false; /*error "build" used outside of binding context.*/
     }

docs/rules/computed-property-spacing.md

@@ -4,6 +4,8 @@ While formatting preferences are very personal, a number of style guides require
 or disallow spaces between computed properties in the following situations:
 
 ```js
+/*eslint-env es6*/
+
 // computed properties
 var obj = { prop: "value" };
 var a = "prop";
@@ -40,6 +42,8 @@ When `"never"` is set, the following patterns will give a warning:
 
 ```js
 /*eslint computed-property-spacing: [2, "never"]*/
+/*eslint-env es6*/
+
 obj[foo ]                                                       /*error There should be no space before ']'*/
 obj[ 'foo']        /*error There should be no space after '['*/
 var x = {[ b ]: a} /*error There should be no space after '['*/ /*error There should be no space before ']'*/
@@ -50,6 +54,7 @@ The following patterns are considered correct:
 
 ```js
 /*eslint computed-property-spacing: [2, "never"]*/
+/*eslint-env es6*/
 
 obj[foo]
 obj['foo']
@@ -63,6 +68,7 @@ When `"always"` is used, the following patterns will give a warning:
 
 ```js
 /*eslint computed-property-spacing: [2, "always"]*/
+/*eslint-env es6*/
 
 obj[foo]          /*error A space is required after '['*/ /*error A space is required before ']'*/
 var x = {[b]: a}  /*error A space is required after '['*/ /*error A space is required before ']'*/
@@ -77,6 +83,7 @@ The following patterns are considered correct:
 
 ```js
 /*eslint computed-property-spacing: [2, "always"]*/
+/*eslint-env es6*/
 
 obj[ foo ]
 obj[ 'foo' ]

docs/rules/constructor-super.md

@@ -14,6 +14,7 @@ The following patterns are considered problems:
 
 ```js
 /*eslint constructor-super: 2*/
+/*eslint-env es6*/
 
 class A {
     constructor() {
@@ -36,6 +37,7 @@ The following patterns are not considered problems:
 
 ```js
 /*eslint constructor-super: 2*/
+/*eslint-env es6*/
 
 class A {
     constructor() { }

docs/rules/generator-star-spacing.md

@@ -6,6 +6,8 @@ These special functions are indicated by placing an `*` after the `function` key
 Here is an example of a generator function:
 
 ```js
+/*eslint-env es6*/
+
 function* generator() {
     yield "44";
     yield "55";
@@ -15,6 +17,8 @@ function* generator() {
 This is also valid:
 
 ```js
+/*eslint-env es6*/
+
 function *generator() {
     yield "44";
     yield "55";
@@ -24,6 +28,8 @@ function *generator() {
 This is valid as well:
 
 ```js
+/*eslint-env es6*/
+
 function * generator() {
     yield "44";
     yield "55";
@@ -71,6 +77,7 @@ When using `{"before": true, "after": false}` this placement will be enforced:
 
 ```js
 /*eslint generator-star-spacing: [2, {"before": true, "after": false}]*/
+/*eslint-env es6*/
 
 function *generator() {}
 
@@ -83,6 +90,7 @@ When using `{"before": false, "after": true}` this placement will be enforced:
 
 ```js
 /*eslint generator-star-spacing: [2, {"before": false, "after": true}]*/
+/*eslint-env es6*/
 
 function* generator() {}
 
@@ -95,6 +103,7 @@ When using `{"before": true, "after": true}` this placement will be enforced:
 
 ```js
 /*eslint generator-star-spacing: [2, {"before": true, "after": true}]*/
+/*eslint-env es6*/
 
 function * generator() {}
 
@@ -107,6 +116,7 @@ When using `{"before": false, "after": false}` this placement will be enforced:
 
 ```js
 /*eslint generator-star-spacing: [2, {"before": false, "after": false}]*/
+/*eslint-env es6*/
 
 function*generator() {}