pypulseq icon indicating copy to clipboard operation
pypulseq copied to clipboard

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

Open yarikoptic opened this issue 2 years ago • 5 comments

yarikoptic avatar Jul 22 '23 13:07 yarikoptic

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

sravan953 avatar Aug 15 '23 14:08 sravan953

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

yarikoptic avatar Aug 15 '23 16:08 yarikoptic

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

sravan953 avatar Aug 15 '23 16:08 sravan953

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

yarikoptic avatar Aug 15 '23 16:08 yarikoptic

@yarikoptic We introduced typos as a pre-commit hook in #207 so I think we can close this, no?

schuenke avatar Feb 06 '25 11:02 schuenke