You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We're using the Google's docstring style in our project. I've installed this package in order to make sure that my docstrings are consistent across my project's files. However, it seems that it is not able to detect that one of the modules is not using the Google's docstring style.
Here are my dependencies
...
mccabe 0.6.1 McCabe checker, plugin for flake8
...
flake8 3.9.0 the modular source code checker: pep8 pyflakes and co
flake8-docstrings 1.7.0 Extension for flake8 which uses pydocstyle to check docstrings
...
pydocstyle 6.3.0 Python docstring style checker
pyflakes 2.3.1 passive checker of Python programs
Let me know if you need more dependencies. I'm using Python 3.8.13.
I'm running flake8 as follows (but you can probably ignore poetry - just in case, I'm using poetry 1.4.0)
poetry run flake8 myfile.py
or (it does not matter - same result)
poetry run flake8 myfile.py --docstring-convention google
@sigmavirus24 Ok, thanks, but can you be more specific, given that I suppose you're familiar with pydocstyle? Does pydocstyle implement this check? The problem could even be in this package that doesn't correctly use pydocstyle. Without more info, it's unclear to me. So, maybe, this issue shouldn't be closed immediately. Possibly related: PyCQA/pydocstyle#514
Uh oh!
There was an error while loading. Please reload this page.
We're using the Google's docstring style in our project. I've installed this package in order to make sure that my docstrings are consistent across my project's files. However, it seems that it is not able to detect that one of the modules is not using the Google's docstring style.
Here are my dependencies
Let me know if you need more dependencies. I'm using Python 3.8.13.
I'm running flake8 as follows (but you can probably ignore poetry - just in case, I'm using poetry 1.4.0)
or (it does not matter - same result)
Here are my flake8 configs in the
tox.ini
So, for completeness, in
myfile.py
I have a function like this (which does not use Google's docstring style)So, does this tool actually detect these issues, or did I misinterpret the purpose of this tool?
The README says that pydocstyle 4.0.0 added support for the Google's style, so I'd expect this to be detected, given my dependencies
The text was updated successfully, but these errors were encountered: