Update the docs based on eslint/eslint#9049

j-f1 · Jul 31, 2017 · c394f3e · c394f3e
1 parent dbef946
commit c394f3e
Show file tree

Hide file tree

Showing 312 changed files with 346 additions and 307 deletions.
diff --git a/docs/about/index.md b/docs/about/index.md
@@ -1,6 +1,7 @@
 ---
 title: About
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/index.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/architecture.md b/docs/developer-guide/architecture.md
@@ -1,6 +1,7 @@
 ---
 title: Architecture
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/architecture.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/code-conventions.md b/docs/developer-guide/code-conventions.md
@@ -1,6 +1,7 @@
 ---
 title: Code Conventions
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/code-conventions.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/code-path-analysis.md b/docs/developer-guide/code-path-analysis.md
@@ -1,6 +1,7 @@
 ---
 title: Code Path Analysis Details
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/code-path-analysis.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/code-path-analysis/index.md b/docs/developer-guide/code-path-analysis/index.md
@@ -1,6 +1,7 @@
 ---
 title: Code Path Analysis Details
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/README.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/contributing/changes.md b/docs/developer-guide/contributing/changes.md
@@ -1,6 +1,7 @@
 ---
 title: Change Requests
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/changes.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/contributing/index.md b/docs/developer-guide/contributing/index.md
@@ -1,6 +1,7 @@
 ---
 title: Contributing
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/README.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/contributing/new-rules.md b/docs/developer-guide/contributing/new-rules.md
@@ -1,6 +1,7 @@
 ---
 title: New Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/new-rules.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/contributing/pull-requests.md b/docs/developer-guide/contributing/pull-requests.md
@@ -1,6 +1,7 @@
 ---
 title: Pull Requests
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/pull-requests.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/contributing/reporting-bugs.md b/docs/developer-guide/contributing/reporting-bugs.md
@@ -1,6 +1,7 @@
 ---
 title: Reporting Bugs
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/reporting-bugs.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/contributing/rule-changes.md b/docs/developer-guide/contributing/rule-changes.md
@@ -1,6 +1,7 @@
 ---
 title: Rule Changes
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/rule-changes.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/contributing/working-on-issues.md b/docs/developer-guide/contributing/working-on-issues.md
@@ -1,6 +1,7 @@
 ---
 title: Working on Issues
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/working-on-issues.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/development-environment.md b/docs/developer-guide/development-environment.md
@@ -1,6 +1,7 @@
 ---
 title: Development Environment
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/development-environment.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/index.md b/docs/developer-guide/index.md
@@ -1,6 +1,7 @@
 ---
 title: Developer Guide
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/README.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/nodejs-api.md b/docs/developer-guide/nodejs-api.md
@@ -1,6 +1,7 @@
 ---
 title: Node.js API
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/nodejs-api.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/selectors.md b/docs/developer-guide/selectors.md
@@ -1,6 +1,7 @@
 ---
 title: Selectors
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/selectors.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/shareable-configs.md b/docs/developer-guide/shareable-configs.md
@@ -1,6 +1,7 @@
 ---
 title: Shareable Configs
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/shareable-configs.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/source-code.md b/docs/developer-guide/source-code.md
@@ -1,6 +1,7 @@
 ---
 title: Source Code
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/source-code.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/unit-tests.md b/docs/developer-guide/unit-tests.md
@@ -1,6 +1,7 @@
 ---
 title: Unit Tests
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/unit-tests.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/working-with-custom-formatters.md b/docs/developer-guide/working-with-custom-formatters.md
@@ -1,6 +1,7 @@
 ---
 title: Working with Custom Formatters
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/working-with-custom-formatters.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/working-with-plugins.md b/docs/developer-guide/working-with-plugins.md
@@ -1,6 +1,7 @@
 ---
 title: Working with Plugins
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/working-with-plugins.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/working-with-rules-deprecated.md b/docs/developer-guide/working-with-rules-deprecated.md
@@ -1,6 +1,7 @@
 ---
 title: Working with Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/working-with-rules-deprecated.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/developer-guide/working-with-rules.md b/docs/developer-guide/working-with-rules.md
@@ -1,6 +1,7 @@
 ---
 title: Working with Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/working-with-rules.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/maintainer-guide/governance.md b/docs/maintainer-guide/governance.md
@@ -1,6 +1,7 @@
 ---
 title: Governance
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/governance.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/maintainer-guide/index.md b/docs/maintainer-guide/index.md
@@ -1,6 +1,7 @@
 ---
 title: Maintainer Guide
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/README.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/maintainer-guide/issues.md b/docs/maintainer-guide/issues.md
@@ -1,6 +1,7 @@
 ---
 title: Managing Issues
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/issues.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/maintainer-guide/pullrequests.md b/docs/maintainer-guide/pullrequests.md
@@ -1,6 +1,7 @@
 ---
 title: Reviewing Pull Requests
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/pullrequests.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/maintainer-guide/releases.md b/docs/maintainer-guide/releases.md
@@ -1,6 +1,7 @@
 ---
 title: Managing Releases
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/lib/rules/releases.js
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
 

diff --git a/docs/rules/accessor-pairs.md b/docs/rules/accessor-pairs.md
@@ -1,9 +1,9 @@
 ---
 title: accessor-pairs - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesaccessor-pairs.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Enforces getter/setter pairs in objects (accessor-pairs)
 
 It's a common mistake in JavaScript to create an object with just a setter for a property but never have a corresponding getter defined for it. Without a getter, you cannot read the property, so it ends up not being used.

diff --git a/docs/rules/array-bracket-newline.md b/docs/rules/array-bracket-newline.md
@@ -1,9 +1,9 @@
 ---
 title: array-bracket-newline - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesarray-bracket-newline.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # enforce line breaks after opening and before closing array brackets (array-bracket-newline)
 
 (fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

diff --git a/docs/rules/array-bracket-spacing.md b/docs/rules/array-bracket-spacing.md
@@ -1,9 +1,9 @@
 ---
 title: array-bracket-spacing - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesarray-bracket-spacing.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Disallow or enforce spaces inside of brackets (array-bracket-spacing)
 
 (fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

diff --git a/docs/rules/array-callback-return.md b/docs/rules/array-callback-return.md
@@ -1,9 +1,9 @@
 ---
 title: array-callback-return - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesarray-callback-return.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Enforces return statements in callbacks of array's methods (array-callback-return)
 
 `Array` has several methods for filtering, mapping, and folding.

diff --git a/docs/rules/array-element-newline.md b/docs/rules/array-element-newline.md
@@ -1,9 +1,9 @@
 ---
 title: array-element-newline - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesarray-element-newline.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # enforce line breaks between array elements (array-element-newline)
 
 (fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

diff --git a/docs/rules/arrow-body-style.md b/docs/rules/arrow-body-style.md
@@ -1,9 +1,9 @@
 ---
 title: arrow-body-style - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesarrow-body-style.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Require braces in arrow function body (arrow-body-style)
 
 (fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

diff --git a/docs/rules/arrow-parens.md b/docs/rules/arrow-parens.md
@@ -1,9 +1,9 @@
 ---
 title: arrow-parens - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesarrow-parens.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Require parens in arrow function arguments (arrow-parens)
 
 (fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

diff --git a/docs/rules/arrow-spacing.md b/docs/rules/arrow-spacing.md
@@ -1,9 +1,9 @@
 ---
 title: arrow-spacing - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesarrow-spacing.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Require space before/after arrow function's arrow (arrow-spacing)
 
 (fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

diff --git a/docs/rules/block-scoped-var.md b/docs/rules/block-scoped-var.md
@@ -1,9 +1,9 @@
 ---
 title: block-scoped-var - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesblock-scoped-var.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Treat var as Block Scoped (block-scoped-var)
 
 The `block-scoped-var` rule generates warnings when variables are used outside of the block in which they were defined. This emulates C-style block scope.

diff --git a/docs/rules/block-spacing.md b/docs/rules/block-spacing.md
@@ -1,9 +1,9 @@
 ---
 title: block-spacing - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesblock-spacing.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Disallow or enforce spaces inside of single line blocks (block-spacing)
 
 (fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

diff --git a/docs/rules/brace-style.md b/docs/rules/brace-style.md
@@ -1,9 +1,9 @@
 ---
 title: brace-style - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesbrace-style.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Require Brace Style (brace-style)
 
 (fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

diff --git a/docs/rules/callback-return.md b/docs/rules/callback-return.md
@@ -1,9 +1,9 @@
 ---
 title: callback-return - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulescallback-return.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Enforce Return After Callback (callback-return)
 
 The callback pattern is at the heart of most I/O and event-driven programming

diff --git a/docs/rules/camelcase.md b/docs/rules/camelcase.md
@@ -1,9 +1,9 @@
 ---
 title: camelcase - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulescamelcase.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Require Camelcase (camelcase)
 
 When it comes to naming variables, style guides generally fall into one of two camps: camelcase (`variableName`) and underscores (`variable_name`). This rule focuses on using the camelcase approach. If your style guide calls for camelcasing your variable names, then this rule is for you!

diff --git a/docs/rules/capitalized-comments.md b/docs/rules/capitalized-comments.md
@@ -1,9 +1,9 @@
 ---
 title: capitalized-comments - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulescapitalized-comments.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # enforce or disallow capitalization of the first letter of a comment (capitalized-comments)
 
 (fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

diff --git a/docs/rules/class-methods-use-this.md b/docs/rules/class-methods-use-this.md
@@ -1,9 +1,9 @@
 ---
 title: class-methods-use-this - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulesclass-methods-use-this.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # Enforce that class methods utilize `this` (class-methods-use-this)
 
 If a class method does not use `this`, it can safely be made a static function.

diff --git a/docs/rules/comma-dangle.md b/docs/rules/comma-dangle.md
@@ -1,9 +1,9 @@
 ---
 title: comma-dangle - Rules
 layout: doc
+edit_link: https://github.com/eslint/eslint/edit/master/docs/rulescomma-dangle.md
 ---
 <!-- Note: No pull requests accepted for this file. See README.md in the root directory for details. -->
-
 # require or disallow trailing commas (comma-dangle)
 
 (fixable) The `--fix` option on the [command line](../user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.