Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
check-docstring-first false positive on attribute docstrings
See original GitHub issueAttribute docstrings, as defined in PEP-257 are strings immediately following top level module names. For example:
name = "my variable"
"""the name used by the module for x, y, and z"""
The check-docstring-first incorrectly identifies this attribute docstring as a module docstring, indicating either Multiple module docstrings (first docstring on line N). or Module docstring appears after code (code seen on line N)..
In light of this issue, I’m not sure the check-docstring-first check has much value at all. At the very least, the check should not be failing when a docstring follows an assignment.
Issue Analytics
- State:
- Created 7 years ago
- Reactions:1
- Comments:9 (4 by maintainers)
Top Results From Across the Web
Top Related Medium Post
Top Related StackOverflow Question
Troubleshoot Live Code
Top Related Reddit Thread
Top Related Hackernoon Post
Top Related Tweet
Top Related Dev.to Post
Top Related Hashnode Post
I just ran into this. FWIW,
#:is not a part of PEP-257, and (more importantly for me,) comments starting with#:are not picked up by vscode the way that attribute docstrings are.just fyi, that there are use cases for which the
#:workaround doesn’t work.Doubt it, unless you can come up with a good heuristic for differentiating the mistake and the intentional “attribute docstring”