Update docs

CodSpeedHQ · Jun 30, 2024 · ec19e0a · ec19e0a
1 parent 5d16e6e
commit ec19e0a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/doc/user_guide/configuration/all-options.rst b/doc/user_guide/configuration/all-options.rst
@@ -1151,6 +1151,13 @@ Standard Checkers
 
 ``Miscellaneous`` **Checker**
 -----------------------------
+--check-fixme-in-docstring
+""""""""""""""""""""""""""
+*Whether or not to search for fixme's in docstrings.*
+
+**Default:**  ``False``
+
+
 --notes
 """""""
 *List of note tags to take in consideration, separated by a comma.*
@@ -1176,6 +1183,8 @@ Standard Checkers
 .. code-block:: toml
 
    [tool.pylint.miscellaneous]
+   check-fixme-in-docstring = false
+
    notes = ["FIXME", "XXX", "TODO"]
 
    notes-rgx = ""

diff --git a/pylint/checkers/misc.py b/pylint/checkers/misc.py
@@ -51,7 +51,7 @@ def process_module(self, node: nodes.Module) -> None:
 
 
 class EncodingChecker(BaseTokenChecker, BaseRawFileChecker):
-    """BaseChecker for encoding issues.
+    """BaseChecker for encoding issues and fixme notes.
 
     Checks for:
     * warning notes in the code like FIXME, XXX