Skip to content
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

Refactor code to remove unused JSDoc types #24300

Merged
merged 2 commits into from
Oct 14, 2024

Conversation

brokoli777
Copy link

@brokoli777 brokoli777 commented Oct 14, 2024

Fixes #24077

Removes redundant type annotations from JSDocs in TypeScript files where the type is already inferred by TypeScript.

For example:
image

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.

@brokoli777
Copy link
Author

@microsoft-github-policy-service agree

@karthiknadig karthiknadig self-assigned this Oct 14, 2024
@karthiknadig karthiknadig added the debt Covers everything internal: CI, testing, refactoring of the codebase, etc. label Oct 14, 2024
@vs-code-engineering vs-code-engineering bot added this to the October 2024 milestone Oct 14, 2024
@karthiknadig
Copy link
Member

Thanks for cleaning up the JSDocs. We will merge this after tests pass and review. Happy Coding!!

@anthonykim1
Copy link

Thank you for doing this @brokoli777 :)

@karthiknadig karthiknadig merged commit c5a8e4f into microsoft:main Oct 14, 2024
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
debt Covers everything internal: CI, testing, refactoring of the codebase, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Avoid adding types to jsdocs for TS files
3 participants