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

eslint-plugin-tsdoc: suggest a rule to check misused function comment #347

Open
trim21 opened this issue Apr 27, 2023 · 0 comments
Open

Comments

@trim21
Copy link

trim21 commented Apr 27, 2023

raise a error for this:

bad:

// function comment not recognized by tsc
const getShortName = (name: string): string => {
   ...
}

tsc doesn't think this is a function comment and doesn't emit it in type definition.

good:

/**
 * function comment not recognized by tsc
 */
const getShortName = (name: string): string => {
   ...
}
@trim21 trim21 changed the title eslint-plugin-tsdoc: suggest a rule to check function comment eslint-plugin-tsdoc: suggest a rule to check misused function comment Apr 27, 2023
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

No branches or pull requests

1 participant