Pylint: ignore TODO comments - #5814
Conversation
|
@andy-armstrong @jzoldak: you two are probably interested in having a discussion on this pull request. |
|
This is TE-564 |
|
@jzoldak That's fine with me. I've changed it in this PR. Can I get a thumbs-up? |
|
@singingwolfboy did you test that it works as expected? |
|
I was editing the wrong task -- thanks for pointing that out, @jzoldak. I've added it to |
79aabb7 to
9902dcb
Compare
|
👍 Thanks for tackling this, @singingwolfboy. |
|
LGTM 👍 |
Pylint: ignore TODO comments
|
When you merge, could you put TE-564 in the commit message? |
|
Ah you are too quick. No big deal. |
TODOcomments are currently flagged by pylint, which causes them to break the build on Jenkins. We have many TODO comments already in the codebase, and it isn't practical to stop working to fix them all. We also don't want to just delete them: they contain valuable information. However, anytime that code is touched, diff-quality flags the TODO and fails the build.It would be nice if there were a way to have
diff-qualityreport on these TODO comments, but more as a warning, and not have them fail the build. However, I don't know how to do that, so this is the next best solution. TODO comments and similar can always be caught by humans in code review.