docs: add the documentation of the new inline ignore comments

codespell-project / codespell

check code for common misspellings

GNU General Public License v2.0

1.84k stars 470 forks source link

docs: add the documentation of the new inline ignore comments #3390

Closed 12rambau closed 4 months ago

12rambau commented 4 months ago

Doccument the new inline ignore capability from #2400.

Related to #3387

larsoner commented 4 months ago

Thanks!

I'll cut a release today unless there are other PRs we should get in first

DimitriPapadopoulos commented 4 months ago

By the way, GitHub tends to underline code blocks in reST documents:

code-block

That's unrelated to this merge request, but I thought I'd mention it. It seems to happen with most of our code blocks (python and ini) but not toml. Strange.

DimitriPapadopoulos commented 4 months ago

Indeed, that happens with all code-block:: languages but toml:

code-block

See "Code blocks appear as (underlined) links".

Currently, the only workaround is to remove sh, python, and yaml language specifiers (#3391).