Skip to content

More strict linting of jsdocs - #7236

Merged
sokra merged 1 commit into
masterfrom
lint/more-strict-jsdoc
May 9, 2018
Merged

sokra merged 1 commit into
masterfrom
lint/more-strict-jsdoc

Conversation

@sokra

@sokra sokra commented May 8, 2018

Copy link
Copy Markdown
Member

What kind of change does this PR introduce?
lint

Did you add tests for your changes?
n/a

If relevant, link to documentation update:
n/a

Summary
More strict linting of jsdocs
Use TODO over any when type is possible

Does this PR introduce a breaking change?
no

Other information

Use TODO over any when type is possible
@webpack-bot

Copy link
Copy Markdown
Contributor

Thank you for your pull request! The most important CI builds succeeded, we’ll review the pull request soon.

@RemyRylan

Copy link
Copy Markdown

Hey Webpack contributors, don't know if you've seen this before -- but it was news to me that TypeScript is actually using a "fork" of JSDoc called AEDoc. Mostly the same, but a few differences.
Might be useful to take a look if you ever wanted to use some of the tools out there to extract documentation from TypeScript. Tools like TypeDoc already adhere to most of AEDoc.

https://github.com/Microsoft/web-build-tools/wiki/API-Extractor-%7E-AEDoc-tags

@sokra

sokra commented May 9, 2018

Copy link
Copy Markdown
Member Author

@RemyRylan Thanks for this info. Does this also apply here? We are not writing Typescript files but Javascript files.

@sokra
sokra merged commit eda273d into master May 9, 2018
@sokra
sokra deleted the lint/more-strict-jsdoc branch May 9, 2018 07:59
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.

5 participants