codespell-project/codespell
1
0
Fork 0
mirror of https://github.com/codespell-project/codespell.git synced 2025-05-17 23:46:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: Specify .codespellrc is INI formatted

Browse Source 
Closes #3229
This commit is contained in:
Evan Chen
2024-01-02 15:55:35 -08:00
committed by Dimitri Papadopoulos Orfanos
parent 0dd109a3e8
commit 14049fc24d
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.rst
View File

@ -152,6 +152,11 @@ be specified in this file (without the preceding dashes), for example:
count =
quiet-level = 3
The ``.codespellrc`` file is an `INI file <https://en.wikipedia.org/wiki/INI_file>`_,
which is read using Python's
`configparser <https://docs.python.org/3/library/configparser.html#supported-ini-file-structure>`_.
For example, comments are possible using ``;`` or ``#`` as the first character.
Codespell will also check in the current directory for a ``pyproject.toml``
(or a path can be specified via ``--toml <filename>``) file, and the
``[tool.codespell]`` entry will be used, but only if the tomli_ package