Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

W0511: Doesn't detect TODO in docstrings #9255

Open
mueller-ma opened this issue Nov 22, 2023 · 5 comments · May be fixed by #9281
Open

W0511: Doesn't detect TODO in docstrings #9255

mueller-ma opened this issue Nov 22, 2023 · 5 comments · May be fixed by #9281
Assignees
@shenjunjie2003
Labels
Enhancement ✨ Improvement to a component Good first issue Friendly and approachable by new contributors Help wanted 🙏 Outside help would be appreciated, good for new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation

Comments

@mueller-ma
Copy link

mueller-ma commented Nov 22, 2023 •
edited

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 mueller-ma added the Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling label Nov 22, 2023
@Pierre-Sassoulas Pierre-Sassoulas added Enhancement ✨ Improvement to a component Help wanted 🙏 Outside help would be appreciated, good for new contributors Good first issue Friendly and approachable by new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation and removed Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling labels Nov 26, 2023
@shenjunjie2003
Copy link

I'd like to work on this issue

@Pierre-Sassoulas
Copy link
Member

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

@shenjunjie2003
Copy link

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.

@Pierre-Sassoulas
Copy link
Member

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.

@shenjunjie2003
Copy link

Yep! I found it. Thanks!

@shenjunjie2003 shenjunjie2003 linked a pull request Dec 4, 2023 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shenjunjie2003 shenjunjie2003

Labels
Enhancement ✨ Improvement to a component Good first issue Friendly and approachable by new contributors Help wanted 🙏 Outside help would be appreciated, good for new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

issue9255 - Detect FIXME words in docstring shenjunjie2003/pylint
3 participants
@Pierre-Sassoulas @mueller-ma @shenjunjie2003