search

upenn-cis1xx / camelot

A fully-modular OCaml style linter
https://opam.ocaml.org/packages/camelot/
Apache License 2.0
44 stars 5 forks source link

Line length linter yells at comments? #55

Closed Vighnesh-V closed 3 years ago

Vighnesh-V commented 3 years ago

Describe the bug The code for line length checking flags commented lines exceeding 80 characters as a style violation.

To Reproduce Steps to reproduce the behavior: From the main directory run: dune exec -- bin/camelot.exe -f test/examples/verbose.ml

Expected behavior Unclear what expected behaviour is - should we flag this? @Zdancewic @KeenWill @dlike230 @swapneelsheth.

If this is an error we can address, might be an interesting dev project? We could toggle it via a linter flag / fix the actual linting code to not flag this as an style problem.

Screenshots If applicable, add screenshots to help explain your problem. image

Desktop (please complete the following information):

dlike230 commented 3 years ago

I feel like we should keep this rule for comments. Having long comments that you need to scroll sideways to see sometimes leads to bad readability.

KeenWill commented 3 years ago

Agree with Dan. All lines should obey the 80 (or 100 for Java) limit for readability

KeenWill commented 3 years ago

Closing for now. We can reopen later if this is a thing we actually want changed.