Skip to content

Commit e237d03

Browse files
committed
Allow TODO with a issue number for pylint fixme checker
Closes #24
1 parent 0c6691b commit e237d03

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

pydocstringformatter/formatting/formatter.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,7 @@ def _treat_string(self, tokeninfo: tokenize.TokenInfo) -> str:
6161
+ "."
6262
+ tokeninfo.string[first_linebreak:]
6363
)
64-
# pylint: disable=fixme
65-
# TODO: Handle multi-line docstrings that do not have a summary
64+
# TODO(#26): Handle multi-line docstrings that do not have a summary
6665
# This is obviously dependent on whether 'pydocstringformatter' will
6766
# start enforcing summaries :)
6867
return tokeninfo.string

pyproject.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ no-docstring-rgx = "__.*__"
4545
[tool.pylint.TYPECHECK]
4646
generated-members = "argparse.Namespace"
4747

48+
[tool.pylint.MISCELLANEOUS]
49+
notes=["XXX","FIXME"]
50+
notes-rgx = 'TODO(?!\(#\d+\))'
51+
4852
[tool.isort]
4953
profile = "black"
5054
known_third_party = ["pytest"]

0 commit comments

Comments
 (0)