Skip to content

D205 Support - Auto-fixes and Stragglers#32212

Merged
potiuk merged 1 commit into
apache:mainfrom
aws-mwaa:ferruzzi/pydocstyle-205/pt1-autofixes-and-stragglers
Jun 27, 2023
Merged

D205 Support - Auto-fixes and Stragglers#32212
potiuk merged 1 commit into
apache:mainfrom
aws-mwaa:ferruzzi/pydocstyle-205/pt1-autofixes-and-stragglers

Conversation

@ferruzzi

@ferruzzi ferruzzi commented Jun 27, 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.

Included in this chunk

Anything ruff could automatically fix and anything I saw that was only one or two files in the directory.

To test

If you comment out this line and run pre-commit in main you will get around 937 errors. After these changes, "only" 898 remain and none of the files touched here should be on the list. After uncommenting that line and rerunning pre-commits, there should be zero regressions.

937 errors on the wall... 937 errors... take forty down, patch them around...


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

Includes anything ruff could automatically fix and anything I saw that was only one or two files in the directory.
@potiuk
potiuk merged commit 2794c41 into apache:main Jun 27, 2023
@ephraimbuddy ephraimbuddy added this to the Airflow 2.7.0 milestone Jul 6, 2023
@ephraimbuddy ephraimbuddy added the type:improvement Changelog: Improvements label Jul 6, 2023
@ephraimbuddy ephraimbuddy added the type:misc/internal Changelog: Misc changes that should appear in change log label Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:CLI area:plugins area:providers area:Scheduler including HA (high availability) scheduler area:secrets area:serialization area:Triggerer kind:documentation provider:amazon AWS/Amazon - related issues provider:cncf-kubernetes Kubernetes (k8s) provider related issues type:improvement Changelog: Improvements 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.

3 participants