-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Avoid adding types to jsdocs for TS files #24077
Comments
Another example: vscode-python/src/client/common/terminal/syncTerminalService.ts Lines 96 to 99 in 34dac5c
|
Hi! I would like to help with this, for the second example, it would be just be like this, right?
Is this issue only covering files under |
@brokoli777 the idea is to remove information that TS already knows about. So for the example export class SynchronousTerminalService implements ITerminalService, Disposable { |
Fixes #24077 Removes redundant type annotations from JSDocs in TypeScript files where the type is already inferred by TypeScript. For example: ![image](https://github.com/user-attachments/assets/9ee1f0b6-f36f-4f4f-81dc-5178d46808cb) Here I removed JSDoc types but I still kept all the useful information. I tried to be on the liberal side to avoid removing any comments that provide useful context or clarify behavior. If I missed any or if more can be removed, I’m happy to go over it again. Additionally, if this issue only applies to a specific folder or scope, please let me know so I can make the necessary adjustments.
This
{SplitLinesOptions=}
isn't needed for example and just adds potential for bitrot:vscode-python/src/client/common/stringUtils.ts
Lines 12 to 16 in 34dac5c
The text was updated successfully, but these errors were encountered: