docs(eslint-plugin): remove duplicate option descriptions on various rules #10748
Conversation
|
Thanks for the PR, @ronami! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
View your CI Pipeline Execution ↗ for commit 34e98bc.
☁️ Nx Cloud last updated this comment at |
| @@ -119,7 +119,7 @@ const foo = <Foo props={{ bar: 1 } as Bar} />; | |||
|
|
|||
| {/* insert option description */} | |||
|
|
|||
| Always prefer `const x: T[] = [ ... ];` to `const x = [ ... ] as T[];` (or similar with angle brackets). | |||
| For example, this would prefer `const x: T[] = [ ... ];` to `const x = [ ... ] as T[];` (or similar with angle brackets). | |||
There was a problem hiding this comment.
Matching the description of objectLiteralTypeAssertions, as the option description is very similar: Whether to always prefer type declarations for array literals used as variable initializers, rather than type assertions.
| @@ -148,8 +148,6 @@ const msg1 = `arg = ${arg}`; | |||
|
|
|||
| {/* insert option description */} | |||
|
|
|||
| Whether to allow additional types in template expressions. | |||
There was a problem hiding this comment.
Option's description is slightly different: Types to allow in template expressions..
| @@ -181,8 +181,6 @@ Also, if you would like to ignore all primitives types, you can set `ignorePrimi | |||
|
|
|||
| {/* insert option description */} | |||
|
|
|||
| Whether to ignore expressions that coerce a value into a boolean: `Boolean(...)`. | |||
There was a problem hiding this comment.
Option's description is slightly different: Whether to ignore arguments to the `Boolean` constructor.
345e82e
into
typescript-eslint:main
PR Checklist
Overview
This PR removes duplicated (or very similar) option descriptions some rules have, which makes the documentation of these options confusing: https://typescript-eslint.io/rules/no-confusing-void-expression/#ignorearrowshorthand.