pylint icon indicating copy to clipboard operation
pylint copied to clipboard

W0511: Doesn't detect TODO in docstrings

Open mueller-ma opened this issue 2 years ago • 5 comments

Bug description

# TODO: Write good doc strings.

def foobar():
    """
    TODO: Implement
    """

Configuration

No response

Command used

pylint todo.py

Pylint output

************* Module todo
todo.py:1:1: W0511: TODO: Write good doc strings. (fixme)
todo.py:1:0: C0114: Missing module docstring (missing-module-docstring)

------------------------------------------------------------------
Your code has been rated at 0.00/10 (previous run: 0.00/10, +0.00)

Expected behavior

I expect the TODO: Implement to lead to an error reported by pylint.

Pylint version

pylint 3.0.2
astroid 3.0.1
Python 3.11.2 (main, Mar 13 2023, 12:18:29) [GCC 12.2.0]

OS / Environment

Debian 12 in WSL 2

Additional dependencies

No response

mueller-ma avatar Nov 22 '23 07:11 mueller-ma

I'd like to work on this issue

shenjunjie2003 avatar Dec 03 '23 21:12 shenjunjie2003

Thank you @shenjunjie2003, I assigned you to it :)

Pierre-Sassoulas avatar Dec 03 '23 21:12 Pierre-Sassoulas

When I am using dev pylint, the fixme words in comments are not being detected. But they are indeed being detected in the version 3.0.2 which I am currently using.

shenjunjie2003 avatar Dec 04 '23 04:12 shenjunjie2003

Might be due to pylint's pylintrc influencing what you do. I would start by creating a functional test in tests/functional with an associated conf file enabling fixme.

Pierre-Sassoulas avatar Dec 04 '23 07:12 Pierre-Sassoulas

Yep! I found it. Thanks!

shenjunjie2003 avatar Dec 04 '23 18:12 shenjunjie2003