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.

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

flake8-spellcheck ignoring docstring #93

Open
oldGreyEagle opened this issue Sep 19, 2024 · 0 comments
Open

flake8-spellcheck ignoring docstring #93

oldGreyEagle opened this issue Sep 19, 2024 · 0 comments

Comments

@oldGreyEagle
Copy link

oldGreyEagle commented Sep 19, 2024

I may be doing something wrong. Any help is appreciated.

Setup

Name: flake8
Version: 7.1.1
Summary: the modular source code checker: pep8 pyflakes and co
Home-page: https://github.com/pycqa/flake8
Author: Tarek Ziade
Author-email: [email protected]
License: MIT
Location: ./env/lib/python3.10/site-packages
Requires: mccabe, pycodestyle, pyflakes
Required-by: flake8-spellcheck

Name: flake8-spellcheck
Version: 0.28.0
Summary: Spellcheck variables, comments and docstrings
Home-page: https://github.com/MichaelAquilina/flake8-spellcheck
Author: Michael Aquilina
Author-email: [email protected]
License: MIT
Location: ./env/lib/python3.10/site-packages
Requires: flake8

Both installed just now with pip in my venv (I call env).
I use Python 3.10.12 on Ubuntu Linux 22.04.4 LTS

flake8 Config

This is my config:

[flake8]
dictionaries=en_US,python,technical,pandas,django
select = SC100, SC200
spellcheck-targets = names, comments
whitelist = project_dict.txt
exclude = ./venv,./env

Remark: There are two environment folders excluded, because the runner in our GIT uses "venv" and I use "env" locally for historical reasons.

How to Reproduce

I test flake8 to find something like this:

class TestThisCode:
    """Do some fuunny nonsense ."""

    # fuunny, isn't it

It does find the second occurrence of "fuunny", but not the one in the docstring.
Running it in the root folder as flake8.

Thank you for your help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant