uber-archive / lint-trap

JavaScript linter module for Uber projects
26 stars 2 forks source link

Turn off the required param description. #89

Closed mishabosin closed 9 years ago

mishabosin commented 9 years ago

Summary: Having an insightful comment for a function parameter is often critical, but when the parameters to a function are well named and self-explanatory, adding a redundant description just adds noise to the docs and creates more work for both the author and the consumer. For example:

In a function named 'divide'

In a function named 'getTrip'

Please don't make these comments mandatory. Setting the configuration based on: http://eslint.org/docs/rules/valid-jsdoc.html