FIX: codespell in pre-comit hook not recognizing ignored words list

[kierisi]

This issue relates to our CI / pre-commit workflow where we use codespell. the task here is to ensure that we are able to ignore certain words that codespell flags as "mispellings". It seems to not be recognizing the setup of having a file with ignored words in it.

open PR

codespell throws an error when we include the name "Ned", and suggests we use "Need" instead. to mitigate this, I've set up the following:

• a pyproject.toml file with the following code:

  [tool.codespell] ignore-words = "codespell-ignore.txt" skip = "./.git,./.nox,./_static,./_build,codespell-ignore.txt,*.svg"

• a text file - codespell-ignore.txt - with Ned's name in it

I haven't had much time to poke around at why this isn't working, and would love if someone could help tackle this!

[flpm]

After some research, looks like the issue is that the words in the "codespell-ignore.txt" file should be in lowercase, it seems to work with ned instead of Ned

[sosey]

heh, I also found that you can ignore the codespell-ignore.txt and use the list, see https://github.com/sosey/pyopensci.github.io/tree/update-pr387

[blink1073]

It looks like this was fixed by #386. :smile:

[flpm]

Yeah, we fixed during the PyCon US Sprints, this issue can be closed now.

[lwasser]

thank you everyone! all of this feedback is awesome. i will close this as this issue was fixed!

[lwasser]

@all-contributors please add @blink1073 for review

[allcontributors[bot]]

@lwasser

I've put up a pull request to add @blink1073! :tada:

[lwasser]

@all-contributors please add @sosey for review

[allcontributors[bot]]

@lwasser

I've put up a pull request to add @sosey! :tada: