B021: f-string used as docstring. #230
Merged
Conversation
This file contains 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
Zac-HD
reviewed
Mar 19, 2022
There was a problem hiding this comment.
One small tweak below so that we can detect all the f-string cases, but otherwise looks good to me! @cooperlees?
Co-authored-by: Zac Hatfield-Dodds <zac.hatfield.dodds@gmail.com>
cooperlees
approved these changes
Mar 20, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #211.
The logic for detecting these f-strings intended as docstrings is fairly simple: Check that the first child of the
FunctionDef/ClassDefis aJoinedStr.I've added a working unit test and ran the pre-commit checks but since this is my first contribution here lmk if I've missed anything 😄