Docs: various rule corrections

cookch10 · markelog · commit ee7577d4cbb2 · 2016-02-02T11:16:31.000+03:00
* disallowNestedTernaries: fixes incorrect option type * disallowSpaceAfterObjectKeys: adds missing option type Fixes #2092 Closes gh-2115
diff --git a/lib/rules/disallow-nested-ternaries.js b/lib/rules/disallow-nested-ternaries.js
@@ -1,9 +1,9 @@
 /**
  * Disallows nested ternaries.
  *
- * Types: `Boolean`, `Integer`
+ * Types: `Boolean`, `Object`
  *
- * Values: `true` or an Integer that describes the maximum levels of nesting to be allowed.
+ * Values: `true` or an Object that contains a `maxLevel` property equal to an integer indicating the maximum levels of nesting to be allowed.
  *
  * #### Examples
  *
diff --git a/lib/rules/disallow-space-after-object-keys.js b/lib/rules/disallow-space-after-object-keys.js
@@ -1,7 +1,7 @@
 /**
  * Disallows space after object keys.
  *
- * Types: `Boolean` or `String`
+ * Types: `Boolean`, `String`, or `Object`
  *
  * Values:
  *  - `true`

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`/**`
`2`	`2`	`* Disallows nested ternaries.`
`3`	`3`	`*`
`4`		- * Types: `Boolean`, `Integer`
	`4`	+ * Types: `Boolean`, `Object`
`5`	`5`	`*`
`6`		- * Values: `true` or an Integer that describes the maximum levels of nesting to be allowed.
	`6`	+ * Values: `true` or an Object that contains a `maxLevel` property equal to an integer indicating the maximum levels of nesting to be allowed.
`7`	`7`	`*`
`8`	`8`	`* #### Examples`
`9`	`9`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`/**`
`2`	`2`	`* Disallows space after object keys.`
`3`	`3`	`*`
`4`		- * Types: `Boolean` or `String`
	`4`	+ * Types: `Boolean`, `String`, or `Object`
`5`	`5`	`*`
`6`	`6`	`* Values:`
`7`	`7`	* - `true`