diff --git a/docs/rules/forbid-elements.md b/docs/rules/forbid-elements.md index 0bc37d2db2..5ec57d0abc 100644 --- a/docs/rules/forbid-elements.md +++ b/docs/rules/forbid-elements.md @@ -53,6 +53,6 @@ React.createElement(Namespaced.Element); React.createElement('div', {}, React.createElement('button', {}, React.createElement('input'))); ``` -## When not to use +## When Not To Use It If you don't want to forbid any elements. diff --git a/docs/rules/forbid-foreign-prop-types.md b/docs/rules/forbid-foreign-prop-types.md index e78c86fead..ae8cb5ab0a 100644 --- a/docs/rules/forbid-foreign-prop-types.md +++ b/docs/rules/forbid-foreign-prop-types.md @@ -25,7 +25,7 @@ Examples of **correct** code for this rule: import SomeComponent, {propTypes as someComponentPropTypes} from './SomeComponent'; ``` -## When not to use +## When Not To Use It This rule aims to make a certain production optimization, removing prop types, less prone to error. This rule may not be relevant to you if you do not wish to make use of this optimization. diff --git a/docs/rules/forbid-prop-types.md b/docs/rules/forbid-prop-types.md index b582efcef9..d577f4906f 100644 --- a/docs/rules/forbid-prop-types.md +++ b/docs/rules/forbid-prop-types.md @@ -60,6 +60,6 @@ Whether or not to check `contextTypes` for forbidden prop types. The default val Whether or not to check `childContextTypes` for forbidden prop types. The default value is `false`. -## When not to use +## When Not To Use It This rule is a formatting/documenting preference and not following it won't negatively affect the quality of your code. This rule encourages prop types that more specifically document their usage. diff --git a/docs/rules/function-component-definition.md b/docs/rules/function-component-definition.md index 1f87f778dc..5851d3baeb 100644 --- a/docs/rules/function-component-definition.md +++ b/docs/rules/function-component-definition.md @@ -249,6 +249,6 @@ function getComponent() { ``` -## When not to use +## When Not To Use It If you are not interested in consistent types of function components. diff --git a/docs/rules/jsx-closing-bracket-location.md b/docs/rules/jsx-closing-bracket-location.md index fb5527939a..1b6adb4328 100644 --- a/docs/rules/jsx-closing-bracket-location.md +++ b/docs/rules/jsx-closing-bracket-location.md @@ -212,6 +212,6 @@ var x = function() { ; ``` -## When not to use +## When Not To Use It If you are not using JSX then you can disable this rule. diff --git a/docs/rules/jsx-closing-tag-location.md b/docs/rules/jsx-closing-tag-location.md index 2095934df7..d4cc4623dd 100644 --- a/docs/rules/jsx-closing-tag-location.md +++ b/docs/rules/jsx-closing-tag-location.md @@ -33,6 +33,6 @@ Examples of **correct** code for this rule: marklar ``` -## When not to use +## When Not To Use It If you do not care about closing tag JSX alignment then you can disable this rule. diff --git a/docs/rules/jsx-first-prop-new-line.md b/docs/rules/jsx-first-prop-new-line.md index e9e2353c6d..d4e22c6322 100644 --- a/docs/rules/jsx-first-prop-new-line.md +++ b/docs/rules/jsx-first-prop-new-line.md @@ -105,6 +105,6 @@ Examples of **correct** code for this rule, when configured with `"multiline-mul "react/jsx-first-prop-new-line": `"always" | "never" | "multiline" | "multiline-multiprop"` ``` -## When not to use +## When Not To Use It If you are not using JSX then you can disable this rule. diff --git a/docs/rules/jsx-indent-props.md b/docs/rules/jsx-indent-props.md index 09ff048e4a..572055fe10 100644 --- a/docs/rules/jsx-indent-props.md +++ b/docs/rules/jsx-indent-props.md @@ -119,6 +119,6 @@ firstName="John" /> ``` -## When not to use +## When Not To Use It If you are not using JSX then you can disable this rule. diff --git a/docs/rules/jsx-indent.md b/docs/rules/jsx-indent.md index 4950cd459e..2f0bb76ebe 100644 --- a/docs/rules/jsx-indent.md +++ b/docs/rules/jsx-indent.md @@ -110,6 +110,6 @@ Examples of **correct** code for this rule: ``` -## When not to use +## When Not To Use It If you are not using JSX then you can disable this rule. diff --git a/docs/rules/jsx-key.md b/docs/rules/jsx-key.md index e454db186c..9becf034e2 100644 --- a/docs/rules/jsx-key.md +++ b/docs/rules/jsx-key.md @@ -57,7 +57,7 @@ Examples of **incorrect** code for this rule: ; ``` -## When not to use +## When Not To Use It If you are not using JSX then you can disable this rule. diff --git a/docs/rules/jsx-max-depth.md b/docs/rules/jsx-max-depth.md index c95fc4ec02..919a57820b 100644 --- a/docs/rules/jsx-max-depth.md +++ b/docs/rules/jsx-max-depth.md @@ -79,6 +79,6 @@ Examples of **correct** code for this rule: ``` -## When not to use +## When Not To Use It If you are not using JSX then you can disable this rule. diff --git a/docs/rules/jsx-max-props-per-line.md b/docs/rules/jsx-max-props-per-line.md index 182dc05d33..18bedeaf29 100644 --- a/docs/rules/jsx-max-props-per-line.md +++ b/docs/rules/jsx-max-props-per-line.md @@ -94,6 +94,6 @@ Examples of **correct** code for this rule: /> ``` -## When not to use +## When Not To Use It If you are not using JSX then you can disable this rule. diff --git a/docs/rules/jsx-sort-default-props.md b/docs/rules/jsx-sort-default-props.md index 9aaf44a4db..b57c52080b 100644 --- a/docs/rules/jsx-sort-default-props.md +++ b/docs/rules/jsx-sort-default-props.md @@ -180,6 +180,6 @@ export default class ClassWithSpreadInPropTypes extends BaseClass { When `true` the rule ignores the case-sensitivity of the declarations order. -## When not to use +## When Not To Use It This rule is a formatting preference and not following it won't negatively affect the quality of your code. If alphabetizing `defaultProps` declarations isn't a part of your coding standards, then you can leave this rule off. diff --git a/docs/rules/jsx-sort-props.md b/docs/rules/jsx-sort-props.md index 2b8e36e295..49c876ed7e 100644 --- a/docs/rules/jsx-sort-props.md +++ b/docs/rules/jsx-sort-props.md @@ -98,6 +98,6 @@ With `reservedFirst: ["key"]`, the following will **not** warn: ``` -## When not to use +## When Not To Use It This rule is a formatting preference and not following it won't negatively affect the quality of your code. If alphabetizing props isn't a part of your coding standards, then you can leave this rule off. diff --git a/docs/rules/no-namespace.md b/docs/rules/no-namespace.md index 7ba843e6cc..ee202f62c0 100644 --- a/docs/rules/no-namespace.md +++ b/docs/rules/no-namespace.md @@ -24,6 +24,6 @@ The following patterns are **not** considered warnings: ``` -## When not to use +## When Not To Use It If you are not using React. diff --git a/docs/rules/sort-prop-types.md b/docs/rules/sort-prop-types.md index 8ed8310f5b..e8b09f66f7 100644 --- a/docs/rules/sort-prop-types.md +++ b/docs/rules/sort-prop-types.md @@ -159,6 +159,6 @@ var Component = createReactClass({ }); ``` -## When not to use +## When Not To Use It This rule is a formatting preference and not following it won't negatively affect the quality of your code. If alphabetizing props declarations isn't a part of your coding standards, then you can leave this rule off.