fix: event declaration additional tags #253
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Regarding the comment for the event declaration, it seems that the
@deprecated
tag description does not follow JSDoc rules because it is written for multiple methods at once.https://jsdoc.app/tags-deprecated.html
https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#deprecated
typescript-eslint/typescript-eslint#1223
With the current output format, some methods are not detected by ESLint (eslint-plugin-deprecation) error checking, so it may be difficult to notice when an event you are using is deprecated.
I think it would be better to be able to emit the
@deprecated
tag for each method so that ESLint can check all usage of deprecated events.Before correction:
Revised: