D205 Support - Utils#32591
Merged
Merged
Conversation
ferruzzi
commented
Jul 13, 2023
Contributor
Author
There was a problem hiding this comment.
There were four docstrings that I can't think of a way to cleanly summarize, I'd love some advice on those ones if anyone has any ideas.
The static check failures are the four I am asking for advice to change and will go away once I fix them.
edit - those comments did not work as planned. I should have seen that coming...
# Conflicts: # airflow/utils/task_group.py
Contributor
Author
|
Thanks @shubham22 , those sound great to me. I'll get those implemented some time today and push them along with the merge-conflict fix. 👍 |
Co-author: shubham22
ferruzzi
added
the
use public runners
o-nikolas
reviewed
Jul 17, 2023
Removed superfluous whitespace
o-nikolas
approved these changes
Jul 17, 2023
ephraimbuddy
added
the
type:misc/internal
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Part of #10742
D205 asserts that all docstrings must have a one-line summary ending in a period. If there is more than one sentence then there must be a blank line before the rest of the docstring. Meeting these requirements could be as simple as adding a newline, or might require some rephrasing.
There are almost a thousand violations in the repo so we're going to have to take this in bites.
PLEASE NOTE
There should be zero changes to any functional logic or type hinting in this PR, only changes to docstrings and whitespace. If you see otherwise, please call it out.
Included in this chunk
All files in the
airflow/utilsmodule.To test
If you comment out this line and run pre-commit in main and noite the total number of errors reported by
ruff- somewhere around 253 errors. After these changes, there will be 76 fewer errors - "only" 177 as of right now - and no files in theairflow/utilsfolder should be on the list. After uncommenting that line and rerunning pre-commits, there should be zero regressions.