Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace pylint with more flake8 plugins #337

Merged
merged 12 commits into from
Dec 14, 2021
Merged

Replace pylint with more flake8 plugins #337

merged 12 commits into from
Dec 14, 2021

Conversation

leouieda
Copy link
Member

Following fatiando/harmonica#285, replace pylint with a bunch of new flake8 plugins. They cover most of the checks that were performed before, add a few new ones, and are less troublesome to maintain and silence when necessary. Fixes the formatting issues raised after applying the changes: making tutorials/examples fit 79 char comments/docstrings, silence a few issues because of scikit-learn style code, reorder imports because of isort. I also combined the CI checks into only 2: "format" and "style". If formatting is broken, we don't need to know which one is complaining, just run make format. And style is now only flake8 anyway.

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

@leouieda
Copy link
Member Author

This PR depends on #336 being merged and should be rebased to main once that happens.

@leouieda leouieda marked this pull request as ready for review December 14, 2021 11:29
@leouieda
Copy link
Member Author

@santisoler just FYI this does a few simplifications on top of what you've done in Harmonica. Mainly some CI stuff and putting all the configuration in pyproject.toml and setup.cfg instead of a bunch of individual tool files. This will be particularly handy in the future when we transition away from setup.py.

@leouieda leouieda merged commit a39215a into main Dec 14, 2021
@leouieda leouieda deleted the ditch-pylint branch December 14, 2021 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant