Remove JSDoc annotations in TS files #4187
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.
This PR can be seen as a continuation of #4135.
I removed the JSDoc annotations in
.d.ts
files.Before:
After:
I did this because JSDoc annotations (so
@param
and@returns
) are just unnecessary noise. They just repeat the function signature and contain zero information.Note that this only affects the generates TS files. The JSDoc annotations are wanted in JS files and are remain unchanged.
With this PR, I would actually consider the form of generated
.d.ts
files to be good. At least for my use case, they are now exactly what I want.