Skip to content

D205 Support - Jobs#32450

Merged
kaxil merged 1 commit into
apache:mainfrom
aws-mwaa:ferruzzi/pydocstyle-205/jobs
Jul 8, 2023
Merged

D205 Support - Jobs#32450
kaxil merged 1 commit into
apache:mainfrom
aws-mwaa:ferruzzi/pydocstyle-205/jobs

Conversation

@ferruzzi

@ferruzzi ferruzzi commented Jul 8, 2023

Copy link
Copy Markdown
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 logic changes 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/jobs module.

To test

If you comment out this line and run pre-commit in main you will get 284 errors. After these changes, "only" 269 remain and no files in the dag_processing folder should be on the list. After uncommenting that line and rerunning pre-commits, there should be zero regressions.

@ferruzzi
ferruzzi requested review from XD-DENG, ashb and kaxil as code owners July 8, 2023 21:58
@boring-cyborg boring-cyborg Bot added area:Scheduler including HA (high availability) scheduler area:Triggerer labels Jul 8, 2023
@kaxil
kaxil merged commit 156b85a into apache:main Jul 8, 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:Scheduler including HA (high availability) scheduler area:Triggerer type:misc/internal Changelog: Misc changes that should appear in change log

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants