From ec19e0ac9366dc07dfdc9d1d05a68f1fd861d4fe Mon Sep 17 00:00:00 2001 From: Daniel Wang Date: Sun, 30 Jun 2024 17:03:06 -0400 Subject: [PATCH] Update docs --- doc/user_guide/configuration/all-options.rst | 9 +++++++++ pylint/checkers/misc.py | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/doc/user_guide/configuration/all-options.rst b/doc/user_guide/configuration/all-options.rst index eb7d72f2a3..0f728330eb 100644 --- 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 index 037ec07b79..14488340c6 100644 --- 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