-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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.
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
Have spellchecker ignore black/flake8/bandit directives #4320
Comments
I think it makes sense. |
great! those are the tools I use that I've noticed causing problems. Are there any other directives you think would be useful for me to add while I'm adding these? |
Also...I personally never use |
Pycharm use |
sounds good. I'm familiar with mypy, but I'm a could you specify the exact syntax you want added for isort? is that 'isort:skip' what appears directly after the |
Sorry. It's |
I'm struggling to figure out how to test a docstring for a module (for the isort module-level directive). It appears all the existing test cases are only testing docstrings in functions or classes (so no easy example to base the new code off of). If I do the following, I get an
|
Yeah it's ok to leave it out and maybe add it later. I never used this isort feature myself. |
Is your feature request related to a problem? Please describe
The spellchecker raises errors for things like
# fmt: on
(ablack
directive),# noqa
(flake8 directive), and# nosec
(bandit directive).Describe the solution you'd like
These should be ignored. A potential implementation would be adding a filter like already exists for Sphinx directives.
Adding them to the "words to ignore" dictionary is suboptimal. A filter could be much more restrictive and require that it appear right next to the
#
comment symbol and not allow them to pass as false negatives of actual misspelled words in other portions of the comment.Would you be open to a PR to address this?
The text was updated successfully, but these errors were encountered: