Skip to content

Conversation

@ferruzzi
Copy link
Contributor

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/utils module.

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/utils folder should be on the list. After uncommenting that line and rerunning pre-commits, there should be zero regressions.

Copy link
Contributor Author

@ferruzzi ferruzzi left a comment

Choose a reason for hiding this comment

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

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
@ferruzzi
Copy link
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 ferruzzi added the use public runners Makes sure that Public runners are used even if commiters creates the PR (useful for testing) label Jul 17, 2023
@ferruzzi ferruzzi closed this Jul 17, 2023
@ferruzzi ferruzzi reopened this Jul 17, 2023
Removed superfluous whitespace
@o-nikolas o-nikolas merged commit 9d0006f into apache:main Jul 17, 2023
@ephraimbuddy ephraimbuddy added the type:misc/internal Changelog: Misc changes that should appear in change log label Aug 2, 2023
@ephraimbuddy ephraimbuddy added this to the Airflow 2.7.0 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:logging type:misc/internal Changelog: Misc changes that should appear in change log use public runners Makes sure that Public runners are used even if commiters creates the PR (useful for testing)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants