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 #168

Merged
merged 1 commit into from
Oct 3, 2024
Merged

chore: convert JSDoc comments to TSDoc #168

merged 1 commit into from
Oct 3, 2024

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.

@dsanders11 dsanders11 requested review from a team as code owners October 3, 2024 02:31
Copy link
Contributor

@itsananderson itsananderson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume TSDoc will just have stub docs (with name and type) for params that aren't explicitly documented?

@dsanders11
Copy link
Member Author

@itsananderson, I believe so, yes. It can pull the parameter names and types from the code itself, the @param comments just supplement those with additional information.

@dsanders11 dsanders11 merged commit b8a0cb4 into main Oct 3, 2024
3 checks passed
@dsanders11 dsanders11 deleted the chore/tsdoc branch October 3, 2024 22: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.

2 participants