issue9255 - Detect FIXME words in docstring

doc/whatsnew/fragments/9255.new_check

@@ -0,0 +1,3 @@
+Added a ``fixme-in-docstring`` message to check TODO, FIXME inside doc strings
+
+Closes #9255

pylint/checkers/base/docstring_checker.py

@@ -73,6 +73,11 @@ class DocStringChecker(_BasicChecker):
             "docstring.",
             {"old_names": [("C0111", "missing-docstring")]},
         ),
+        "C0150": (
+            "%s",
+            "fixme-in-docstring",
+            "Used when a warning note as FIXME or XXX is detected in docstring.",
+        ),
     }
     options = (
         (
@@ -156,7 +161,7 @@ def _check_docstring(
         report_missing: bool = True,
         confidence: interfaces.Confidence = interfaces.HIGH,
     ) -> None:
-        """Check if the node has a non-empty docstring."""
+        """Check if the node has a non-empty docstring and check for fixme words."""
         docstring = node.doc_node.value if node.doc_node else None
         if docstring is None:
             docstring = _infer_dunder_doc_attribute(node)
@@ -206,3 +211,14 @@ def _check_docstring(
             self.add_message(
                 "empty-docstring", node=node, args=(node_type,), confidence=confidence
             )
+        else:
+            fixme_words = self.linter.config.notes
+            for word in fixme_words:
+                if word in docstring:
+                    self.add_message(
+                        "fixme-in-docstring",
+                        node=node,
+                        args=(word,),
+                        confidence=confidence,
+                    )
+                    break

pylintrc

@@ -108,6 +108,7 @@ disable=
     format,
     # We anticipate #3512 where it will become optional
     fixme,
+    fixme-in-docstring,
     consider-using-assignment-expr,
 
 

tests/functional/d/docstrings_fixme.py

@@ -0,0 +1,27 @@
+# pylint: disable=unnecessary-pass, consider-using-f-string
+
+"""
+Test fixme in docstrings.
+"""
+
+def func1(): # [fixme-in-docstring]
+    """
+    TODO: Implement
+    """
+
+# fixme-in-docstring
+def func2(): # [fixme-in-docstring]
+    """
+    FIXME: Implement
+    """
+
+# fixme-in-docstring
+def func3(): # [fixme-in-docstring]
+    """
+    XXX: Implement
+    """
+
+def func4():
+    """
+    This is regular docstring
+    """

tests/functional/d/docstrings_fixme.txt

@@ -0,0 +1,3 @@
+fixme-in-docstring:7:0:7:9:func1:TODO:HIGH
+fixme-in-docstring:13:0:13:9:func2:FIXME:HIGH
+fixme-in-docstring:19:0:19:9:func3:XXX:HIGH