Add CI check that generated documentation is up to date

.github/workflows/checks.yaml

@@ -158,3 +158,9 @@ jobs:
             echo "Make sure that 'tox -e docs' succeed without any modifications locally." ; \
             exit 1; \
           }
+      - name: Check that generated documentation is up to date
+        run: |
+          if ! git diff --exit-code; then
+            echo "::error::Generated documentation is out of date. Run 'tox -e docs' locally and commit the changes."
+            exit 1
+          fi

doc/user_guide/checkers/extensions.rst

@@ -270,7 +270,7 @@ Verbatim name of the checker is ``dict-init-mutate``.
 
 Dict-Init-Mutate checker Messages
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-:dict-init-mutate (C3401): *Declare all known key/values when initializing the dictionary.*
+:dict-init-mutate (C3401): *Declare all known key/values when initializing the dictionary: %s*
   Dictionaries can be initialized with a single statement using dictionary
   literal syntax.
 

doc/user_guide/configuration/all-options.rst

@@ -8,7 +8,6 @@
 Standard Checkers
 ^^^^^^^^^^^^^^^^^
 
-Remember that only ``tool.pylint`` is required, the section title is not. There are specific notes under each example that cover this.
 
 .. _main-options:
 
@@ -91,6 +90,13 @@ Remember that only ``tool.pylint`` is required, the section title is not. There
 **Default:**  ``10``
 
 
+--files
+"""""""
+*The files to lint. The flag can also be omitted as pylint will try to lint any file passed as argument. This can be used to set files to a directory in a configuration file and invoke pylint by only typing pylint on the command line. Any file passed as argument will overwrite any file set in the configuration file.*
+
+**Default:**  ``[]``
+
+
 --from-stdin
 """"""""""""
 *Interpret the stdin as a python script, whose filename needs to be passed as the module_or_package argument.*
@@ -250,6 +256,8 @@ Remember that only ``tool.pylint`` is required, the section title is not. There
 
    fail-under = 10
 
+   files = []
+
    from-stdin = false
 
    ignore = ["CVS"]