starsimhub / styleguide

Guidelines for contributing to Covasim and other "starsim" models
MIT License
0 stars 0 forks source link

Consider additional linters #7

Open cliffckerr opened 1 year ago

cliffckerr commented 1 year ago

From @JSchripsema-IDM :

https://github.com/DmytroLitvinov/awesome-flake8-extensions

Flake8-dunder-all Would this help the "researchers don't know how to write Python as modules? Often an issue when I try to turn on the doc build Flake8-requirements Would this help with the dependency/version issues the docs encounters sometimes? Pep8-naming I could see this being needed in the emodpy space

Extensions for checking docstrings.

[darglint](https://github.com/terrencepreilly/darglint) - Check that the docstring description matches the definition.
[flake8-docstrings](https://github.com/pycqa/flake8-docstrings) - Include checks provided by pep257.
[flake8-rst-docstrings](https://github.com/peterjc/flake8-rst-docstrings) - Validate Python docstrings as reStructuredText (RST).
[flake8-spellcheck](https://github.com/MichaelAquilina/flake8-spellcheck) - Spellcheck variables, classnames, comments, docstrings etc.
[flake8-sphinx-links](https://github.com/python-formate/flake8-sphinx-links) - Check docstrings for double backticked strings which should be links to the Python documentation.

flake8-rst - Checks on code in *.rst files or in docstrings.

nitpick - Enforce the same lint configuration (flake8, isort, mypy, pylint) across multiple Python projects.

From https://github.com/DmytroLitvinov/awesome-flake8-extensions

Type annotations

Pandas-vet, since we often have pandas problems? flake8-rst - Checks on code in *.rst files or in docstrings.

From https://github.com/DmytroLitvinov/awesome-flake8-extensions

(better than sphinx doc-test?) Html linkcheck

Darglint uses google style by default

Grammar/style specific linters • Vale • Woke • Write-good • Sublime lint (? Can I add writing ones? Doesn't seem like it, but there is an rst linter) • Sphinx-lint

JSchripsema-IDM commented 1 year ago

@RCarter-IDM, see this ticket for additional info on linter work