Skip to content

Add codespell support (config, workflow to detect/not fix) and make it fix some typos#370

Merged
alejoe91 merged 7 commits intoSpikeInterface:mainfrom
yarikoptic:enh-codespell
Oct 20, 2025
Merged

Add codespell support (config, workflow to detect/not fix) and make it fix some typos#370
alejoe91 merged 7 commits intoSpikeInterface:mainfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Copy Markdown
Contributor

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

I excluded release notes but could be fixed too:

image

wanna?

…nteractively

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 4 ./tests/test_io/test_openephys.py",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
…os automagically

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.92%. Comparing base (9279d1f) to head (7d4c337).
⚠️ Report is 135 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #370   +/-   ##
=======================================
  Coverage   89.92%   89.92%           
=======================================
  Files          12       12           
  Lines        2044     2044           
=======================================
  Hits         1838     1838           
  Misses        206      206           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@JoeZiminski
Copy link
Copy Markdown

Would recommend, @yarikoptic introduced this to a few of our repos and it never has false positives + has caught many typos!

@h-mayorquin
Copy link
Copy Markdown
Collaborator

It does a small number of false positives for us but I think it is worth it:

https://github.com/catalystneuro/neuroconv/blob/c37482aab970c277b2f47550b841c4d92d9f06d7/pyproject.toml#L447-L450

I am +1 on this.

But I am behind @samuelgarcia if he does not want more linters. I would not burn our pre-commit/linter credits on this one if we only get a few : p

@alejoe91
Copy link
Copy Markdown
Member

It does a small number of false positives for us but I think it is worth it:

https://github.com/catalystneuro/neuroconv/blob/c37482aab970c277b2f47550b841c4d92d9f06d7/pyproject.toml#L447-L450

I am +1 on this.

But I am behind @samuelgarcia if he does not want more linters. I would not burn our pre-commit/linter credits on this one if we only get a few : p

I think we have a quorum :) Let's go for it!

@alejoe91 alejoe91 merged commit 593f13a into SpikeInterface:main Oct 20, 2025
6 of 7 checks passed
@samuelgarcia
Copy link
Copy Markdown
Member

j'ai mal.

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.

5 participants