search

phetsims / chipper

Tools for developing and building PhET interactive simulations.
http://scenerystack.org/
MIT License
11 stars 14 forks source link

Verify jsdoc #424

Open samreid opened 8 years ago

samreid commented 8 years ago

I noticed eslint has a plugin that verifies jsdoc. Should we evaluate it for potential PhET usage?

https://github.com/gajus/eslint-plugin-jsdoc/blob/master/README.md

samreid commented 8 years ago

@pixelzoom says it is nice that it checks for casing on number and Object @jessegreenberg said it seems like it may be beneficial during code review @jonathanolson says it is worth investigation

Seems like a good "rainy day" wishlist issue.

pixelzoom commented 8 years ago

@samreid is this a duplicate of https://github.com/phetsims/chipper/issues/385? (Common code repos should pass eslint:valid-jsdoc)

samreid commented 8 years ago

It looks like we previously decided to make sure common repos should pass eslint:valid-jsdoc, at lower priority. I guess this issue could be for non-common repos, also at lower priority.