[Testing:Developer] Remove CodeSpell

[skara9]

Remove the codespell workflow.

[bmcutler]

This particular codespell package because it is not a full dictionary comparison, but rather an incomplete list of possible misspellings. We had multiple false negatives (unreported misspellings) and at least one false positive (correctly spelled name flagged as misspelled). We were not able to force skip the false positive, so we therefore decided the best course of action at this time is to remove this package.

[prestoncarman]

The ignore words list must be lower case. Otherwise it will not recognize the word.

[prestoncarman]

I did some research into the codespell documentation. It seems others have also found the ignore list confusing. They just updated the documentation (codespell-project/codespell#2466) to attempt to clarify how the ignore list is used. The updated readme has a section explaining how "Ignoring Words" works.

Posting a note here for future reference.

[skara9]

@prestoncarman Thanks for the information, it's very much appreciated.

However, I think it's still best to leave out codespell from our PR workflow since its potential costs seem to outweigh the benefits in our case.

For example, say we add the pair tung=>tongue to the ignore file. Now this correction wouldn't be made across the whole site, which sort of defeats its purpose. We could alternatively provide the full line of occurrence to be ignored in another file, but then this would have to be updated every time the line is modified. If it isn't updated to match, we'd be leaving garbage.

Rather than having to maintain an exhaustive list of ignored word corrections and lines every time we update the documentation and always keep track of them, it would be much easier to routinely use some sort of simple browser extension to highlight unrecognized words which we can then discover and correct as necessary. This has the added benefit of working for all misspelled words and not just those that are in the codespell corrections list, which would otherwise fly under the radar.