Add support for comments in `--ignore-words` file

[Jakuje]

At this moment, the file --ignore-words is taken verbatim as a list of words to ignore. But each of these exceptions or groups of words usually have some reason so I would suggest to implement a functionality to allow comments in this file. Starting a line with # is probably the most common way to write an comment.

From my reading of the code, these lines will result in no matches today as nothing in the dictionary will match anything with #, but having these lines excluded explicitly and documented would hopefully improve maintainability of these ignore files.

[matkoniecz]

The same in --skip. Right now part of my codespell alias looks like this

--skip "##############################" \
--skip "####### skipping not English" \
--skip "##############################" \
--skip "pl_words.txt" \
--skip "analiza %/percent_input.csv" \
--skip "cele_wycieczek.html" \
--skip "*kody-pocztowe_GUS.csv" --skip "*kody-pocztowe.csv" \
--skip "*/comparing_csv_lists/list.csv" \
--skip "*/OSM software/hidden-gems/*.html" \
--skip "zh_CN.po" --skip "fr.po" --skip "de.po" \

Though maybe at this point I should look into https://github.com/codespell-project/codespell#using-a-config-file ?

But not sure is there a good way to put comments there or split given parameter into multiple groups.

[DimitriPapadopoulos]

@matkoniecz This issue is about adding comments to the file specified by --ignore-words, which lists words to that will be ignored by codespell.

It is worth digging into your question, which is about --skip, but I would recommend you create a new issue.

[matkoniecz]

Maybe, but right now it is clear that bottleneck is on processing pull requests anyway, so investigating problem and filing more issues is not useful.

[DimitriPapadopoulos]

@matkoniecz I intend to investigate this issue if a new ticket is created. I will not investigate it in this specific ticket. Why add a comment if you think issues and pull requests will never be processed any way?