diff --git a/README.rst b/README.rst index ee28e0a3e3..e229b36dfe 100644 --- a/README.rst +++ b/README.rst @@ -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 `_, +which is read using Python's +`configparser `_. +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 ``) file, and the ``[tool.codespell]`` entry will be used, but only if the tomli_ package