CODEWITHSUNDEEP
pycharmdocstringtodo
MrLeeh
MrLeeh

Reputation: 5589

How to let PyCharm find Todo items in docstrings?

I was just playing around with PyCharms TODO finder. It is a nice feature and I would like to use it more intense. However it doesn't find any todo entries that I use in my docstrings.

"""
Do something.

:todo: This is my Todo-Item that is sadly not found

"""
# Todo: When I use line comments it is found.
def my_function():
    pass

Is there a way to configure PyCharm to find todo items in docstrings?

Upvotes: 1

Views: 1526

Answers (2)

Seth
Seth

Reputation: 46453

PyCharm supports TODOs in Docstrings since version 2017.3

See: https://youtrack.jetbrains.com/issue/PY-11040

Upvotes: 1

MrLeeh
MrLeeh

Reputation: 5589

If I got it right PyCharm makes a difference between comments like

# Comment

and docstrings like 

"""
My function does this and that.

"""

TODO entries are only looked for in comments. So 

"""
My function does this and that.

todo: add something else

"""

wont work.

Upvotes: 0

Related Questions