Add docs

stylelint · Jun 9, 2017 · 79a1ff4 · 79a1ff4
1 parent d09da33
commit 79a1ff4
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 8 deletions.
diff --git a/docs/user-guide/rules.md b/docs/user-guide/rules.md
@@ -255,7 +255,7 @@ Here are all the rules within stylelint, grouped by the [*thing*](http://apps.wo
 
 ### General / Sheet
 
--   [`indentation`](../../lib/rules/indentation/README.md): Specify indentation.
+-   [`indentation`](../../lib/rules/indentation/README.md): Specify indentation (Autofixable).
 -   [`max-empty-lines`](../../lib/rules/max-empty-lines/README.md): Limit the number of adjacent empty lines.
 -   [`max-line-length`](../../lib/rules/max-line-length/README.md): Limit the length of a line.
 -   [`max-nesting-depth`](../../lib/rules/max-nesting-depth/README.md): Limit the depth of nesting.

diff --git a/lib/rules/at-rule-empty-line-before/README.md b/lib/rules/at-rule-empty-line-before/README.md
@@ -12,7 +12,7 @@ a {}
 
 If the at-rule is the very first node in a stylesheet then it is ignored.
 
-The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule.
+The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule. We recommend to enable [`indentation`](../indentation/README.md) rule for better autofixing results with this rule.
 
 ## Options
 

diff --git a/lib/rules/comment-empty-line-before/README.md b/lib/rules/comment-empty-line-before/README.md
@@ -16,7 +16,7 @@ If you're using a custom syntax which support single-line comments with `//`, th
 
 **Caveat:** Comments within *selector and value lists* are currently ignored.
 
-The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule.
+The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule. We recommend to enable [`indentation`](../indentation/README.md) rule for better autofixing results with this rule.
 
 ## Options
 

diff --git a/lib/rules/custom-property-empty-line-before/README.md b/lib/rules/custom-property-empty-line-before/README.md
@@ -12,7 +12,7 @@ a {
  *                   This line */
 ```
 
-The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule.
+The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule. We recommend to enable [`indentation`](../indentation/README.md) rule for better autofixing results with this rule.
 
 ## Options
 

diff --git a/lib/rules/declaration-empty-line-before/README.md b/lib/rules/declaration-empty-line-before/README.md
@@ -14,7 +14,7 @@ a {
 
 This rule only applies to standard property declarations. Use the [`custom-property-empty-line-before`](../custom-property-empty-line-before/README.md) rule for custom property declarations.
 
-The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule.
+The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule. We recommend to enable [`indentation`](../indentation/README.md) rule for better autofixing results with this rule.
 
 ## Options
 

diff --git a/lib/rules/indentation/README.md b/lib/rules/indentation/README.md
@@ -13,6 +13,8 @@ Specify indentation.
  * The indentation at these three points */
 ```
 
+The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule.
+
 ## Options
 
 `int|"tab"`, where `int` is the number of spaces
@@ -188,7 +190,7 @@ a {
 @media print {
   a {
     color: pink;
-  }  
+  }
 }
 ```
 
@@ -204,7 +206,7 @@ a {
 @media print {
   a {
     color: pink;
-    }  
+    }
   }
 ```
 

diff --git a/lib/rules/rule-empty-line-before/README.md b/lib/rules/rule-empty-line-before/README.md
@@ -12,7 +12,7 @@ b {}  /* ↑ */
 
 If the rule is the very first node in a stylesheet then it is ignored.
 
-The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule.
+The `--fix` option on the [command line](../../../docs/user-guide/cli.md#autofixing-errors) can automatically fix all of the problems reported by this rule. We recommend to enable [`indentation`](../indentation/README.md) rule for better autofixing results with this rule.
 
 ## Options