-
Notifications
You must be signed in to change notification settings - Fork 102
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CU-86948uv4g docstring signature consistency #417
Merged
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
…ures match doc strings)
…ures match doc strings)
… signatures match doc strings)
…ignature validation
Task linked: CU-86948uv4g Ensure docstrings match signature |
tomolopolis
approved these changes
Apr 18, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
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.
I've just realised that my previous PR on the same task was a flop.
The reason flake8 was checking doc strings and comparing them with the method signatures was because I had
darglint
installed locally. Not because of the newerflake8
version as I had assumed.I hadn't realised that
darglint
would silently work withflake8
.So what this PR does is add
darglint
to dev requirements.This will force
flake8
to run through and check the doc strings match methods signatures on the GHA side just as it did for me locally when I was making the various changes before.PS:
This is likely to add 2-3 minutes to each GitHub Actions run because
darglint
is slow.