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

optionExamples: Allow to pass JSON instead of a string #2467

Closed
andy-hanson opened this issue Apr 2, 2017 · 1 comment
Closed

optionExamples: Allow to pass JSON instead of a string #2467

andy-hanson opened this issue Apr 2, 2017 · 1 comment

Comments

@andy-hanson
Copy link
Contributor

Current (taken from arrowReturnShorthandRule.ts):

optionExamples: [
    `[true]`,
    `[true, "${OPTION_MULTILINE}"]`,
],

Desired:

optionExamples: [
    true,
    [true, OPTION_MULTILINE],
],

We can just stringify the examples. This makes it easier to read (for the tslint contributor, in the documentation it will be the same), and the compiler will catch typos.

@andy-hanson
Copy link
Contributor Author

This can be closed now.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants