Skip to content

Commit

Permalink
[doc] Document some internal pylint errors and configuration/option e…
Browse files Browse the repository at this point in the history
…rror (#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 <13665637+DanielNoord@users.noreply.github.com>
  • Loading branch information
Pierre-Sassoulas and DanielNoord authored Sep 4, 2023
1 parent 884f5a7 commit c2bcd0b
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 6 deletions.
15 changes: 14 additions & 1 deletion doc/data/messages/b/bad-plugin-value/details.rst
Original file line number Diff line number Diff line change
@@ -1 +1,14 @@
You can help us make the doc better `by contributing <https://github.com/pylint-dev/pylint/issues/5953>`_ !
One of your pylint plugins cannot be loaded. There's nothing to change in
your code, but your pylint configuration or installation has an issue.

For example, there might be a typo. The following config::

[MAIN]
load-plugins = pylint.extensions.bad_biultin

Should be::

[MAIN]
load-plugins = pylint.extensions.bad_builtin

Or the plugin you added is not importable in your environment.
1 change: 0 additions & 1 deletion doc/data/messages/b/bad-plugin-value/good.py

This file was deleted.

3 changes: 2 additions & 1 deletion doc/data/messages/r/raw-checker-failed/details.rst
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
You can help us make the doc better `by contributing <https://github.com/pylint-dev/pylint/issues/5953>`_ !
This warns you that a builtin module was impossible to analyse (an ast node is not pure python).
There's nothing to change in your code, this is a warning about astroid and pylint's limitations.
1 change: 0 additions & 1 deletion doc/data/messages/r/raw-checker-failed/good.py

This file was deleted.

16 changes: 15 additions & 1 deletion doc/data/messages/u/unrecognized-option/details.rst
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
You can help us make the doc better `by contributing <https://github.com/pylint-dev/pylint/issues/5953>`_ !
One of your options is not recognized. There's nothing to change in
your code, but your pylint configuration or the way you launch
pylint needs to be modified.

For example you might be launching pylint with the following ``toml`` configuration::

[tool.pylint]
jars = "10"

When the following should be used::

[tool.pylint]
jobs = "10"

This warning was released in pylint 2.14: bad options were silently failing before.
1 change: 0 additions & 1 deletion doc/data/messages/u/unrecognized-option/good.py

This file was deleted.

0 comments on commit c2bcd0b

Please sign in to comment.