search

PyCQA / flake8

flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code.
https://flake8.pycqa.org
Other
3.39k stars 306 forks source link

Allow TODO issue with pound sign anywhere in text #1916

Closed shaunc closed 6 months ago

shaunc commented 6 months ago

describe the request

Visual studio code prompts to autocreate issues in current repo for todos. It inserts the issue # immediately after colon: Before

# TODO(charlie): fix this

After

# TODO(charlie): #234 fix this

This format seems clear and works with tooltip support in visual studio code.

asottile commented 6 months ago

this has nothing to do with flake8

shaunc commented 6 months ago

Ah - sorry. I saw that flake8-todos didn't have issue tracker and assumed issues must be consolidated here.

asottile commented 6 months ago

if you read the issue template or any of the prompts why would that make sense?

shaunc commented 6 months ago

Hmm... you mean: "NOTE: flake8 is a linting framework and does not implement any checks"?

I guess I was not familiar with the architecture, so that note was opaque to me (what is a "check"?). ("All of the individual rules are checked by plugins." or something like that?)

asottile commented 6 months ago

this seems pretty clear to me, did you not read this part?

if you are reporting a problem with a particular check, please track down the plugin which implements that check

shaunc commented 6 months ago

That is clear - but it doesn't show up in the template?

image

Or in the linked "requesting a new feature" in the contribution guide:

image