search

imr-framework / pypulseq

Pulseq in Python
https://pypulseq.readthedocs.io
GNU Affero General Public License v3.0
112 stars 58 forks source link

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

Open yarikoptic opened 12 months ago

sravan953 commented 11 months ago

Thanks for this @yarikoptic ! Does codespell then submit a PR with corrections?

yarikoptic commented 11 months ago

no -- just fails the workflow and it would be for contributor to fix locally (by running codespell or manually)

sravan953 commented 11 months ago

I understand how this would work for PRs, but would it open an issue for pushes to the dev branch?

yarikoptic commented 11 months ago

nope, it would just fail the workflow (in https://github.com/imr-framework/pypulseq/actions). But sending out PRs sounds like a cool feature to request , so I did: https://github.com/codespell-project/actions-codespell/issues/68