Linter

Stream: CSLib

[Kim Morrison]

I think we should turn on the linter before it's too late! Currently Cslib looks pretty good, it's just doc-strings that are missing.

This should just involve adding lintDriver = "batteries/runLinter" to the lakefile. That should then fail CI, and we could repair the missing doc-strings in other PRs (or add exceptions in nolints.json).

[Chris Henson]

Yes, I believe it is mostly in good shape because I had enabled most of the batteries linters here. I didn't realize I could specify the batteries lint driver like that, thanks for the info! It is also nice that docs#Batteries.Tactic.Lint.getChecks is designed in a way that it picks up the Cslib environment linter I wrote for namespace usage.

I had left off the docs linters at the time because I wanted to get the testing in place early, but agree we should go ahead and fix these. I opened cslib#181 for this, can respective file authors please add documentation where the failures in CI indicate? Thanks!

[Chris Henson]

After cleaning up docs for notations (mostly missing @[inherit_doc]) there are only 27 docstrings to add, so this shouldn't be too tedious.

[Fabrizio Montesi]

Can somebody add a few lines to the README or CONTRIBUTING file that tell people how to run all linters/tests/etc.? I sometimes get notified by people surprised that CI fails for their PRs. :-)

[Chris Henson]

Sure, I can do this.

[Shreyas Srinivas]

#lint

[Shreyas Srinivas]

It’s a command you can run in a file that gives you all the linter errors

[Chris Henson]

cslib#213