Adds note to Readme about check-docstring-first
#1160
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
hmmm I don't really want to document that as I don't think your workaround is passing intentionally. it's a quirk of how the hook uses the tokenizer |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I bumped into the same issue raised in #159. I found a quick workaround after looking at the code, and updated the Readme with a note for anyone else looking for the same.
Using VS Code (ver 1.99.3) I was able to add an attribute docstring wrapped in
()and still get the docstring hint on hover, withoutpre-commit-hooksflagging the file.