Skip to content

Commit

Permalink
doc: Specify .codespellrc is INI formatted
Browse files Browse the repository at this point in the history
Closes #3229
  • Loading branch information
vEnhance authored and DimitriPapadopoulos committed Jan 4, 2024
1 parent 0dd109a commit 14049fc
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 14049fc

Please sign in to comment.