- Notifications
You must be signed in to change notification settings - Fork1.8k
Restrict comments to 100 characters#4668
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This is a rule I try enforce in PR but it's a bit of a hassle, this willgive 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 warningsSpecial case comments are ignored which includes@vt comments, tablecomments and commented out code.
Similar toxtermjs#4668, this brings linting to the API files with a cut downset 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 ofwrapping or API going off screen regardless of resolution or window/browsersize
jerch commentedAug 12, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Hmm yeah the |
Tyriar commentedAug 12, 2023
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.