diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2021-11-22 09:42:59 +0100 |
|---|---|---|
| committer | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2021-11-22 13:36:48 +0100 |
| commit | 312c4f22ddf9444787e9b54b368d616e7bfc1389 (patch) | |
| tree | a88c270d62f5ba13ec5d9fb4f5466db254a031cb | |
| parent | d29bcf68393b6a1654aa6cd3d5351ed63edb42ad (diff) | |
| download | pylint-git-312c4f22ddf9444787e9b54b368d616e7bfc1389.tar.gz | |
[doc] Add basic documentation for toml configuration files
| -rw-r--r-- | doc/user_guide/run.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/user_guide/run.rst b/doc/user_guide/run.rst index a4a13d580..5f280a4e7 100644 --- a/doc/user_guide/run.rst +++ b/doc/user_guide/run.rst @@ -100,6 +100,9 @@ configuration file in the following order and uses the first one it finds: #. ``.pylintrc`` in the current working directory #. ``pyproject.toml`` in the current working directory, providing it has at least one ``tool.pylint.`` section. + The ``pyproject.toml`` must prepend section names with ``tool.pylint.``, + for example ``[tool.pylint.'MESSAGES CONTROL']``. They can also be passed + in on the command line. #. ``setup.cfg`` in the current working directory, providing it has at least one ``pylint.`` section #. If the current working directory is in a Python package, Pylint searches \ |