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.

Sign up for GitHub

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

Jump to bottom

JSDoc comments are out-of-date compared to TypeScript types #1755

Open
dstaley opened this issue Aug 30, 2019 · 0 comments
Open

JSDoc comments are out-of-date compared to TypeScript types #1755

dstaley opened this issue Aug 30, 2019 · 0 comments
Assignees
@dstaley
Labels
stale For marking issues as stale. Labeled issues will be closed soon if label is not removed.

Comments

@dstaley
Copy link
Member

dstaley commented Aug 30, 2019

In the process of converting to TypeScript, several methods utilized a different set of parameters compared to their JSDoc strings. I'd like to find a way to fix that along with automate the process of validating them.

I'm going to explore using the TSDoc parser to compare the JSDoc to the function signature and emit errors when they don't match.
@dstaley dstaley self-assigned this Aug 30, 2019
@dstaley dstaley transferred this issue from Kinto/kinto-http.js Apr 4, 2022
@alexcottner alexcottner added the stale For marking issues as stale. Labeled issues will be closed soon if label is not removed. label Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dstaley dstaley

Labels
stale For marking issues as stale. Labeled issues will be closed soon if label is not removed.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dstaley @alexcottner