Docs: Clarify generator-star-spacing config example (fixes #8027) (#8034

)
eslint · Feb 7, 2017 · c596690 · c596690
1 parent a11d4a6
commit c596690
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/docs/rules/generator-star-spacing.md b/docs/rules/generator-star-spacing.md
@@ -58,8 +58,10 @@ The rule takes one option, an object, which has two keys `before` and `after` ha
 
 The default is `{"before": true, "after": false}`.
 
+An example configuration:
+
 ```json
-"generator-star-spacing": ["error", {"before": false, "after": true}]
+"generator-star-spacing": ["error", {"before": true, "after": false}]
 ```
 
 And the option has shorthand as a string keyword:
@@ -69,6 +71,8 @@ And the option has shorthand as a string keyword:
 * `{"before": true, "after": true}` → `"both"`
 * `{"before": false, "after": false}` → `"neither"`
 
+An example of shorthand configuration:
+
 ```json
 "generator-star-spacing": ["error", "after"]
 ```