Restrict comments to 100 characters#4668
Conversation
This is a rule I try enforce in PR but it's a bit of a hassle, this will give a lint warning when it happens resulting in: - Yellow underline in supported editors when eslint is installed - Compilation will succeed since it's a warning not an error - CI will fail as it does not allow lint warnings Special case comments are ignored which includes @vt comments, table comments and commented out code.
Similar to xtermjs#4668, this brings linting to the API files with a cut down set of rules. One of the bigger ones is comment length is restricted to 80, this was done as opposed to 100 for regular code to reduce the chance of wrapping or API going off screen regardless of resolution or window/browser size
|
Hmm yeah the |
|
I like the |
This is a rule I try enforce in PR but it's a bit of a hassle, this will give a lint warning when it happens resulting in:
Special case comments are ignored which includes @vt comments, table comments and commented out code.