Skip to content
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 23 commits into from
Apr 18, 2024

Conversation

mart-r
Copy link
Collaborator

@mart-r mart-r commented Apr 18, 2024

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 newer flake8 version as I had assumed.

I hadn't realised that darglint would silently work with flake8.

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.

mart-r added 23 commits April 9, 2024 09:01
@tomolopolis
Copy link
Member

Copy link
Member

@tomolopolis tomolopolis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mart-r mart-r merged commit 4bda687 into master Apr 18, 2024
5 checks passed
@mart-r mart-r deleted the CU-86948uv4g-docstring-signature-consitency branch August 12, 2024 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants