Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

pydocstyle 6.3.0 fails silently on a python script that has no .py extension #649

Open
dstromberg opened this issue Aug 9, 2023 · 0 comments

Comments

@dstromberg
Copy link

The Subject pretty much says it, but here's supporting detail:

$ pydocstyle lld
below cmd output started 2023 Wed Aug 09 08:43:44 AM PDT
above cmd output done 2023 Wed Aug 09 08:43:44 AM PDT
dstromberg@usbopl-vdi001:~/src/experiments/lock-leak-detect x86_64-pc-linux-gnu 3696430

$ echo $?
below cmd output started 2023 Wed Aug 09 08:43:47 AM PDT
0
above cmd output done 2023 Wed Aug 09 08:43:47 AM PDT
dstromberg@usbopl-vdi001:~/src/experiments/lock-leak-detect x86_64-pc-linux-gnu 3696430

$ mv lld lld.py
below cmd output started 2023 Wed Aug 09 08:43:49 AM PDT
above cmd output done 2023 Wed Aug 09 08:43:49 AM PDT
dstromberg@usbopl-vdi001:~/src/experiments/lock-leak-detect x86_64-pc-linux-gnu 3696430

$ pydocstyle lld.py
below cmd output started 2023 Wed Aug 09 08:43:53 AM PDT
lld.py:10 in public class Logentry:
D101: Missing docstring in public class
lld.py:11 in public method __init__:
D107: Missing docstring in init
lld.py:28 in public method __repr__:
D105: Missing docstring in magic method
lld.py:34 in public class Lockstate:
D101: Missing docstring in public class
lld.py:35 in public method __init__:
D107: Missing docstring in init
lld.py:39 in public method process_logentry:
D102: Missing docstring in public method
lld.py:59 in public method __repr__:
D105: Missing docstring in magic method

$ pydocstyle --version
below cmd output started 2023 Wed Aug 09 08:44:19 AM PDT
6.3.0
above cmd output done 2023 Wed Aug 09 08:44:19 AM PDT

Thanks for the useful tool!

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

No branches or pull requests

1 participant