diff --git a/README.rst b/README.rst index 9d50a33a2c..c138dc1eef 100644 --- a/README.rst +++ b/README.rst @@ -178,6 +178,23 @@ which is read using Python's `configparser `_. For example, comments are possible using ``;`` or ``#`` as the first character. +Values in an INI file entry cannot start with a ``-`` character, so if you need to do this, +structure your entries like this: + +.. code-block:: ini + + [codespell] + dictionary = mydict,- + ignore-words = bar,-foo + +instead of these invalid entries: + +.. code-block:: ini + + [codespell] + dictionary = -,mydict + ignore-words = -foo,bar + 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