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

chore: convert JSDoc comments to TSDoc #1629

Merged
merged 1 commit into from
Aug 24, 2024
Merged

Conversation

dsanders11
Copy link
Member

Most of the "conversion" here is simply deleting @param and @returns which are only types, since they're redundant to the TS types, sometimes wrong, and TSDoc doesn't include types for obvious reasons.

eslint-plugin-tsdoc is disabled in test files due to usage of @jest-environment in some files, and it's unlikely there are going to be TSDoc comments in those files anyway.

@dsanders11 dsanders11 requested a review from erickzhao August 23, 2024 19:26
@dsanders11 dsanders11 marked this pull request as ready for review August 23, 2024 19:29
@dsanders11 dsanders11 requested review from codebytere and a team as code owners August 23, 2024 19:29
@coveralls
Copy link

Coverage Status

coverage: 87.602%. remained the same
when pulling 51a48a4 on chore/convert-jsdoc-to-tsdoc
into f6d785d on main.

@dsanders11 dsanders11 merged commit db18871 into main Aug 24, 2024
10 checks passed
@dsanders11 dsanders11 deleted the chore/convert-jsdoc-to-tsdoc branch August 24, 2024 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants