Add rationale field to prefer-while rule metadata

palantir · Apr 22, 2018 · 84c6d8e · 84c6d8e
1 parent cc218a2
commit 84c6d8e
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/rules/preferWhileRule.ts b/src/rules/preferWhileRule.ts
@@ -23,7 +23,8 @@ export class Rule extends Lint.Rules.AbstractRule {
  /* tslint:disable:object-literal-sort-keys */
  public static metadata: Lint.IRuleMetadata = {
  ruleName: "prefer-while",
- description: "Prefer while loops when instead of a for loop without an initializer and incrementor",
+ description: "Prefer while loops when instead of a for loop without an initializer and incrementor.",
+ rationale: "Simplifies the readability of the loop statement, while maintaining the same functionality.",
  optionsDescription: "Not configurable.",
  options: null,
  optionExamples: [true],