search

dwyl / goodparts

:see_no_evil: An ESLint Style that only allows JavaScript the Good Parts (and "Better Parts") in your code.
GNU General Public License v2.0
78 stars 26 forks source link

capitalized-comments #278

Closed nelsonic closed 7 years ago

nelsonic commented 7 years ago

see: http://eslint.org/docs/rules/capitalized-comments I don't see an advantage to "enforcing" this rule.

ryanpcmcquen commented 7 years ago

Crockford himself writes comments in complete sentences:

screenshot 2016-12-03 at 06 56 51

https://github.com/douglascrockford/JSLint/blob/master/jslint.js#L129

nelsonic commented 7 years ago

@ryanpcmcquen I'm a fan of comments as complete human-readable sentences but if my linter told me I had to capitalise the start of a comment I don't think I would feel 😍 ...

iteles commented 7 years ago

I think the consistency needs to be in the quality of the comments (i.e. they need to make sense to a beginner and include complete information as well as exist in the first place) - if we crack that, the capitalisation is the least of our problems.