[unrecognized-option] Initial documentation

Refs pylint-dev#7897
Pierre-Sassoulas · Sep 2, 2023 · 232c006 · 232c006
1 parent 0f4378a
commit 232c006
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/doc/data/messages/u/unrecognized-option/details.rst b/doc/data/messages/u/unrecognized-option/details.rst
@@ -1 +1,15 @@
-You can help us make the doc better `by contributing <https://github.com/pylint-dev/pylint/issues/5953>`_ !
+One of your option is not recognized. There's nothing to change in
+your code, but the pylint's configuration or the way you launch
+pylint need 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.
diff --git a/doc/data/messages/u/unrecognized-option/good.py b/doc/data/messages/u/unrecognized-option/good.py