Skip to content

Commit 57d343b

Browse files
docs: [no-deprecated] awkward wording about TypeScript visualizing deprecated code (typescript-eslint#10337)
* Inaccuracy in no-deprecated TypeScript can't visualize deprecated code, editors can. * Update packages/eslint-plugin/docs/rules/no-deprecated.mdx Co-authored-by: Kirk Waiblinger <[email protected]> --------- Co-authored-by: Kirk Waiblinger <[email protected]>
1 parent 746560a commit 57d343b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

packages/eslint-plugin/docs/rules/no-deprecated.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ It's best to avoid using code marked as deprecated.
1414
This rule reports on any references to code marked as `@deprecated`.
1515

1616
:::note
17-
[TypeScript recognizes the `@deprecated` tag](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#deprecated) and visualizes deprecated code with a ~strikethrough~.
17+
[TypeScript recognizes the `@deprecated` tag](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#deprecated), allowing editors to visually indicate deprecated code — usually with a ~strikethrough~.
1818
However, TypeScript doesn't report type errors for deprecated code on its own.
1919
:::
2020

0 commit comments

Comments
 (0)