Skip to content

Commit c2bcd0b

Browse files
[doc] Document some internal pylint errors and configuration/option error (#8992)
* [bad-plugin-value] Initial documentation Refs #7897 * [unrecognized-option] Initial documentation Refs #7897 * [raw-checker-failed] Create the initial documentation Co-authored-by: Daniël van Noord <[email protected]>
1 parent 884f5a7 commit c2bcd0b

File tree

6 files changed

+31
-6
lines changed

6 files changed

+31
-6
lines changed
Original file line numberDiff line numberDiff line change
@@ -1 +1,14 @@
1-
You can help us make the doc better `by contributing <https://github.com/pylint-dev/pylint/issues/5953>`_ !
1+
One of your pylint plugins cannot be loaded. There's nothing to change in
2+
your code, but your pylint configuration or installation has an issue.
3+
4+
For example, there might be a typo. The following config::
5+
6+
[MAIN]
7+
load-plugins = pylint.extensions.bad_biultin
8+
9+
Should be::
10+
11+
[MAIN]
12+
load-plugins = pylint.extensions.bad_builtin
13+
14+
Or the plugin you added is not importable in your environment.

doc/data/messages/b/bad-plugin-value/good.py

-1
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
You can help us make the doc better `by contributing <https://github.com/pylint-dev/pylint/issues/5953>`_ !
1+
This warns you that a builtin module was impossible to analyse (an ast node is not pure python).
2+
There's nothing to change in your code, this is a warning about astroid and pylint's limitations.

doc/data/messages/r/raw-checker-failed/good.py

-1
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
1-
You can help us make the doc better `by contributing <https://github.com/pylint-dev/pylint/issues/5953>`_ !
1+
One of your options is not recognized. There's nothing to change in
2+
your code, but your pylint configuration or the way you launch
3+
pylint needs to be modified.
4+
5+
For example you might be launching pylint with the following ``toml`` configuration::
6+
7+
[tool.pylint]
8+
jars = "10"
9+
10+
When the following should be used::
11+
12+
[tool.pylint]
13+
jobs = "10"
14+
15+
This warning was released in pylint 2.14: bad options were silently failing before.

doc/data/messages/u/unrecognized-option/good.py

-1
This file was deleted.

0 commit comments

Comments
 (0)