search

SpikeInterface / spikeinterface

A Python-based module for creating flexible and robust spike sorting pipelines.
https://spikeinterface.readthedocs.io
MIT License
501 stars 186 forks source link

Introduce `codespell` to linting #3122

Open JoeZiminski opened 3 months ago

JoeZiminski commented 3 months ago

As someone with absolutely atrocious spelling and propensity to make typos, I have found the linter codespell to be a useful addition to the pre-commit. It basically highlights spelling errors to be fixed before pushing. It is quite light-touch and works well for scientific packages, I've been using it for a long time now and never come across an instance where it is asking me to fix the spelling on a correctly spelled word. Would people be interested?

h-mayorquin commented 3 months ago

Can it work only in newly introduced changes? If so, I guess that makes sense. + 1

JoeZiminski commented 3 months ago

I think the CI pre-commit would fail if there are existing spelling errors in the codebase, I think the PR that implements this will have to fix all spelling errors in the codebase (happy to do this). But otherwise do you think this could cause problems?

zm711 commented 3 months ago

I think that PR will be closed at 0900 French time.

h-mayorquin commented 3 months ago

There is one version that works on PRs only without having to be a pre-commit. Hopefully that won't be disrupting enough to Sam but a pre-commit will probably be too much.

samuelgarcia commented 3 months ago

Une conspiration à nouveau.