Does .codespellrc support comments?

[your-diary]

Using a config file in README.md says nothing about it.

It seems # and // both work, but are these officially supported as comments or a bug?

[DimitriPapadopoulos]

It's an INI file. We read it using configparser.ConfigParser so the format is pretty standard and beyond our direct reach. Both # and ; work according to the previous link. I am surprised // works, because it's really not standard for INI files.

We should probably specify the config files are INI files.

[your-diary]

Thank you.

I just confirmed configparser.ConfigParser() is used in codespell_lib/_codespell.py.

I am surprised // works, because it's really not standard for INI files.

I noticed any symbols work:

[codespell]

#These are all ignored.
* ignore-words-list = ect
+ ignore-words-list = ect
# ignore-words-list = ect
// ignore-words-list = ect
; ignore-words-list = ect
_ ignore-words-list = ect

#Only this works.
ignore-words-list = ect

Though it seems the comment characters can be customized via comment_prefixes parameter of configparser.ConfigParser() according to Customizing Parser Behaviour, the setting is not used in project, making the situation strange.

We should probably specify the config files are INI files.

I do agree with you.