Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cleanup: comment typos #4957

Closed
wants to merge 1 commit into from
Closed

cleanup: comment typos #4957

wants to merge 1 commit into from

Conversation

@bagder
Copy link
Member

bagder commented Feb 20, 2020

Spotted by 'codespell'

Spotted by 'codespell'
@bagder bagder added the tidy-up label Feb 20, 2020
@bagder

This comment has been minimized.

Copy link
Member Author

bagder commented Feb 20, 2020

I entertained the idea of running codespell as a CI job, but it is much too crude for that to be a good idea:

  1. there's no way to do inlined ignore-sections, we can only ignore full words unconditionally everywhere. At one place we have an example directory list in a comment that causes a whole bunch of complaints...
  2. it spell checks the code too (with no way to disable it) and for example it insists that our variable name 'aline' is potentially a misspelled 'align' and it feels wrong to have to whitelist "aline" for that

This makes the tool much too weird for it to be useful in the CI. I'll instead try to run it manually every once in awhile.

@bagder bagder closed this in 0c76795 Feb 21, 2020
@bagder bagder deleted the bagder/typos branch Feb 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

1 participant
You can’t perform that action at this time.