Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

Improved "complete docs" docs #3823

Merged
merged 1 commit into from
May 1, 2018
Merged

Improved "complete docs" docs #3823

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/rules/completedDocsRule.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(", ")}]`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need to escape this backtick?

or an array with each item in one of two formats:

* \`string\` to enable for that type
Expand Down