MouseLand / suite2p

cell detection in calcium imaging recordings
http://www.suite2p.org
GNU General Public License v3.0
344 stars 240 forks source link

codespell: add config and action to codespell the code to avoid known typos #1006

Closed yarikoptic closed 1 year ago

carsen-stringer commented 1 year ago

thanks I did not know about this tool, does this only check in comments / non-code? I am very wary of any tool that can change actual code (which is why we don't use black)

codecov[bot] commented 1 year ago

Codecov Report

Merging #1006 (437631d) into main (9808eca) will not change coverage. Report is 20 commits behind head on main. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1006   +/-   ##
=======================================
  Coverage   58.69%   58.69%           
=======================================
  Files          40       40           
  Lines        4551     4551           
=======================================
  Hits         2671     2671           
  Misses       1880     1880           
Files Changed Coverage Δ
suite2p/__init__.py 100.00% <ø> (ø)
suite2p/__main__.py 40.98% <ø> (ø)
suite2p/classification/__init__.py 100.00% <ø> (ø)
suite2p/classification/classifier.py 88.88% <ø> (ø)
suite2p/classification/classify.py 100.00% <ø> (ø)
suite2p/default_ops.py 100.00% <ø> (ø)
suite2p/detection/__init__.py 100.00% <ø> (ø)
suite2p/detection/anatomical.py 12.66% <ø> (ø)
suite2p/detection/chan2detect.py 86.84% <ø> (ø)
suite2p/detection/denoise.py 19.35% <ø> (ø)
... and 30 more
yarikoptic commented 1 year ago

It does check everything, including code. I did have cases of finding/fixing typos in scripts not covered through tests. It doesn't change any code unless you ask it when you run it locally - action just checks

carsen-stringer commented 1 year ago

thanks it was helpful to see the typos, but I don't feel comfortable with it being able to change code