search

codespell-project / codespell

check code for common misspellings
GNU General Public License v2.0
1.84k stars 470 forks source link

Codespell inline ignores don't appear to work in Markdown files #3429

Closed d33bs closed 3 months ago

d33bs commented 3 months ago

Hello, thanks for the great work in this project! I found that I'm running into the same as #3396 when using the latest version available via PyPI installations of Codespell. I wanted to open a new issue to help address any challenges that may be present.

My hope is to be able to use inline ignore rules through Codespell as follows:

abandonned <!-- codespell:ignore -->

This doesn't appear to work with the current version deployed through PyPI.

I was able to reproduce the issue in a Google Colab notebook, with a Gist backup (note: the gist appears to not render the markdown comment, but observe the cat below that cell for verification).

Please don't hesitate to let me know if you have any questions or if I may clarify at all.

DimitriPapadopoulos commented 3 months ago

Which version of codespell?

DimitriPapadopoulos commented 3 months ago

Got it. The "latest version available via PyPI" does not include #2400.

What you want is a new release. See #3387.

d33bs commented 3 months ago

Thanks @DimitriPapadopoulos for the clarification!