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: clean up extra * in TSDoc comments #13336

Merged
merged 3 commits into from
Sep 29, 2022
Merged

chore: clean up extra * in TSDoc comments #13336

merged 3 commits into from
Sep 29, 2022

Conversation

mrazauskas
Copy link
Contributor

Summary

TSLint caught some extra * in TSDoc comments in DefinitelyTyped/DefinitelyTyped#62468

I was trying to add eslint-plugin-jsdoc to prevent similar typos in the future. No luck to find the right rule. Hm.. Probably that’s fine for now (;

Test plan

Green CI.

@SimenB
Copy link
Member

SimenB commented Sep 29, 2022

No luck to find the right rule.

https://github.com/gajus/eslint-plugin-jsdoc/blob/master/README.md#check-alignment perhaps?

@mrazauskas
Copy link
Contributor Author

I was trying out jsdoc/check-alignment rule. It caught one problem, but not the double stars. Anyway, it does not hurt to add this rule.

Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

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

👍

@SimenB SimenB merged commit e574964 into jestjs:main Sep 29, 2022
@mrazauskas mrazauskas deleted the chore-clean-up-TSDoc branch September 29, 2022 14:32
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants