codespell-project / codespell

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

Update "Using a config file" README entry #3478

Closed oddhack closed 2 weeks ago

oddhack commented 2 weeks ago

Document behavior with '-' in config file value fields

See https://github.com/codespell-project/codespell/issues/3474#issuecomment-2193878382

Closes #3474

oddhack commented 2 weeks ago

N.b. I suppose the question might come up of wanting to specify a single value which starts with '-' but that would probably require code changes and is out of scope here, which is just documenting the current behavior.

DimitriPapadopoulos commented 2 weeks ago

Thank you @oddhack!