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

D205 Support - Root files #33297

Merged
merged 3 commits into from
Aug 11, 2023

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 logic changes in this PR, only changes to docstrings and whitespace. If you see otherwise, please call it out.

Included in this chunk

The last three "root" level files: setup.py, airflow/exceptions.py, and airflow/configuration.py

To test

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

Updates setup.py, airflow/configuration.py, and airflow/exceptions.py
@ferruzzi ferruzzi force-pushed the ferruzzi/pydocstyle-205/root-files branch from 176273b to c95bbfd Compare August 10, 2023 23:39
@ferruzzi
Copy link
Contributor Author

Strange, wonder why the static checks are failing. It doesn't look related at first glance, but I'll poke at it this afternoon.

@ferruzzi
Copy link
Contributor Author

huh. Running breeze build-docs locally passes in this branch.

image

@ferruzzi
Copy link
Contributor Author

Mypy was grumpy about some missing type hints. Not sure what in this PR triggered it, but I've fixed the complaints.

@potiuk
Copy link
Member

potiuk commented Aug 11, 2023

Mypy was grumpy about some missing type hints. Not sure what in this PR triggered it, but I've fixed the complaints.

Mypy is quite often grumpy about unrelated things. The old guy is useful anywwy, so we keep him around anyway

@potiuk potiuk merged commit 4755fe4 into apache:main Aug 11, 2023
60 of 61 checks passed
ferruzzi added a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Aug 17, 2023
* D205 Support - Root files

Updates setup.py, airflow/configuration.py, and airflow/exceptions.py

* missed one
@ephraimbuddy ephraimbuddy added this to the Airflow 2.7.1 milestone Aug 27, 2023
@ephraimbuddy ephraimbuddy added the type:misc/internal Changelog: Misc changes that should appear in change log label Aug 27, 2023
ephraimbuddy pushed a commit that referenced this pull request Aug 28, 2023
* D205 Support - Root files

Updates setup.py, airflow/configuration.py, and airflow/exceptions.py

* missed one

(cherry picked from commit 4755fe4)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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