Skip to content

Commit 312c4f2

Browse files
[doc] Add basic documentation for toml configuration files
1 parent d29bcf6 commit 312c4f2

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/user_guide/run.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,9 @@ configuration file in the following order and uses the first one it finds:
100100
#. ``.pylintrc`` in the current working directory
101101
#. ``pyproject.toml`` in the current working directory,
102102
providing it has at least one ``tool.pylint.`` section.
103+
The ``pyproject.toml`` must prepend section names with ``tool.pylint.``,
104+
for example ``[tool.pylint.'MESSAGES CONTROL']``. They can also be passed
105+
in on the command line.
103106
#. ``setup.cfg`` in the current working directory,
104107
providing it has at least one ``pylint.`` section
105108
#. If the current working directory is in a Python package, Pylint searches \

0 commit comments

Comments
 (0)