Skip to content

Commit 8236d11

Browse files
committed
doc: clarify config reading
1 parent 7ec60ca commit 8236d11

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,17 @@ These are both equivalent to running::
117117

118118
codespell --quiet-level 3 --count --skip "*.po,*.ts,./src/3rdParty,./src/Test"
119119

120+
If several config files are present, they are read in the following order:
121+
122+
#. ``pyproject.toml``
123+
#. ``setup.cfg``
124+
#. ``.codespellrc``
125+
#. any additional file supplied via ``--config``
126+
127+
If a codespell configuration is supplied in several of these files,
128+
the configuration from the most recently read file overwrites previously
129+
specified configurations.
130+
120131
Any options specified in the command line will *override* options from the
121132
config files.
122133

0 commit comments

Comments
 (0)