[MAINT] Run black, isort, ruff, and other auto-linters on entire package

mne-tools / mne-connectivity

Connectivity algorithms that leverage the MNE-Python API.

https://mne.tools/mne-connectivity/dev/index.html

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

68 stars 34 forks source link

[MAINT] Run black, isort, ruff, and other auto-linters on entire package #159

Closed adam2392 closed 10 months ago

adam2392 commented 10 months ago

Thanks for contributing. If this is your first time, make sure to read contributing.md

PR Description

runs isort and black formatters

Merge checklist

Maintainer, please confirm the following before merging:

[ ] All comments resolved
[ ] This is not your own PR
[ ] All CIs are happy
[ ] PR title starts with [MRG]
[ ] whats_new.rst is updated
[ ] PR description includes phrase "closes <#issue-number>"

larsoner commented 10 months ago

Nowadays in MNE-Python we use pre-commit.ci + .pre-commit-config.yaml to do most style stuff.

For git history it would be best to split this PR into two -- one that runs black and isort and makes yamllint changes with whatever settings you want, and you squash+merge that.

Then in a (much smaller!) follow-up PR you add that commit hash to a new .git-blame-ignore-revs and adjust CIs. Then git blame should be correct on everything.

adam2392 commented 10 months ago

Okay, I'll do all the yaml/toml stuff first in one go, since those are just extra files and then do the whole package black/ruff/isort as you suggest?

larsoner commented 10 months ago

Sure that would work

adam2392 commented 10 months ago

@larsoner do I update the git-blame file after I merge this PR?

larsoner commented 10 months ago

Yep, add 0c216d35127f48792caabdc3cca170874a443eee to .git-blame-revs-ignore and your blame on GitHub and properly configured local gits should work

adam2392 commented 10 months ago

Kay done with the last commit to main