Fix 159: check-docstring-first shall ignore attribute docstring at module top level #812
Conversation
…dule top level Now attribute docstrings no longer complain. https://peps.python.org/pep-0257/#what-is-a-docstring
for more information, see https://pre-commit.ci
|
this breaks the point of the tool entirely -- if it isn't something you want to enforce I'd recommend just removing it instead |
|
#159 is closed because this is "unfixable" but for some who do not (ab)use inline docstrings this is still valuable |
Well, there is plenty of value of putting docstrings before imports, but the tool could ignore further docstrings further down the file. How about protecting the behavior with a command line switch ?
It is not (ab)use, it is following PEP 257 which this tool violates. And you can see in issue 159 links to bugs where people remove this tools because of this same reason. |
|
no thanks |
The hook doesn't support module attribute docstrings and never will apparently: pre-commit/pre-commit-hooks#159 pre-commit/pre-commit-hooks#812
Now attribute docstrings no longer complain.
https://peps.python.org/pep-0257/#what-is-a-docstring
Fixes #159