Improved "complete docs" docs (#3823)

palantir · May 1, 2018 · 9af0b65 · 9af0b65
1 parent 37dddca
commit 9af0b65
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/rules/completedDocsRule.ts b/src/rules/completedDocsRule.ts
@@ -181,9 +181,9 @@ export class Rule extends Lint.Rules.TypedRule {
     /* tslint:disable:object-literal-sort-keys */
     public static metadata: Lint.IRuleMetadata = {
         ruleName: "completed-docs",
-        description: "Enforces documentation for important items be filled out.",
+        description: "Enforces JSDoc comments for important items be filled out.",
         optionsDescription: Lint.Utils.dedent`
-            \`true\` to enable for [${Object.keys(Rule.defaultArguments).join(", ")}]],
+            \`true\` to enable for `[${Object.keys(Rule.defaultArguments).join(", ")}]`,
             or an array with each item in one of two formats:
 
             * \`string\` to enable for that type