Enables linting across the entire project

anaconda / percy

A tool to work on recipes from aggregate.

BSD 3-Clause "New" or "Revised" License

9 stars 0 forks source link

Enables linting across the entire project #84

Closed schuylermartin45 closed 1 year ago

schuylermartin45 commented 1 year ago

Enables lint checking in pre-commit
Skips examples/ directory
Fixes type annotation with Variant; Charles confirmed this change
Ensures all files (non-examples) have annotations from __future__

schuylermartin45 commented 1 year ago

This is a pre-curser to considering to enable the static analyzer. Approximately 250 analyzer errors (out of nearly 3000) got cleaned up as a consequence of making the linter happy.

These fixes should also reduce the current analyzer error count I have on the anaconda-linter project.

schuylermartin45 commented 1 year ago

The linter will accept both types of docstrings and I haven't decided on one over the other yet. We should discuss as a team/group and pick one.

I would lean towards Sphinx so we can auto-generate docs and I find it is a little easier to work with and probably easier for a computer to parse.

One thing we definitely shouldn't do is duplicate the typing info in the docstrings as most tools should be able to parse both and mypy/VS Code only looks at the type annotations.