File tree Expand file tree Collapse file tree 2 files changed +10
-1
lines changed
doc/user_guide/configuration Expand file tree Collapse file tree 2 files changed +10
-1
lines changed Original file line number Diff line number Diff line change @@ -1151,6 +1151,13 @@ Standard Checkers
11511151
11521152``Miscellaneous `` **Checker **
11531153-----------------------------
1154+ --check-fixme-in-docstring
1155+ """"""""""""""""""""""""""
1156+ *Whether or not to search for fixme's in docstrings. *
1157+
1158+ **Default: ** ``False ``
1159+
1160+
11541161--notes
11551162"""""""
11561163*List of note tags to take in consideration, separated by a comma. *
@@ -1176,6 +1183,8 @@ Standard Checkers
11761183.. code-block :: toml
11771184
11781185 [tool.pylint.miscellaneous]
1186+ check-fixme-in-docstring = false
1187+
11791188 notes = ["FIXME", "XXX", "TODO"]
11801189
11811190 notes-rgx = ""
Original file line number Diff line number Diff line change @@ -51,7 +51,7 @@ def process_module(self, node: nodes.Module) -> None:
5151
5252
5353class EncodingChecker (BaseTokenChecker , BaseRawFileChecker ):
54- """BaseChecker for encoding issues.
54+ """BaseChecker for encoding issues and fixme notes .
5555
5656 Checks for:
5757 * warning notes in the code like FIXME, XXX
You can’t perform that action at this time.
0 commit comments