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 - WWW #33298

Merged
merged 2 commits into from
Aug 13, 2023
Merged

D205 Support - WWW #33298

merged 2 commits into from
Aug 13, 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

All files in the airflow/www module.

To test

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

@boring-cyborg boring-cyborg bot added area:API Airflow's REST/HTTP API area:webserver Webserver related Issues labels Aug 11, 2023
Comment on lines 61 to 63
Add `Deprecation HTTP Header Field.

See also: <https://tools.ietf.org/id/draft-dalal-deprecation-header-03.html>`__.
Copy link
Member

Choose a reason for hiding this comment

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

There’s a link syntax that’s broken here

Copy link
Contributor Author

@ferruzzi ferruzzi Aug 11, 2023

Choose a reason for hiding this comment

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

Well spotted, thanks.

Turns out the link is dead. I did a search to find the new home of what should be there and it looks like it's an abandoned proposal: https://datatracker.ietf.org/doc/draft-dalal-deprecation-header/

I just updated the link, but maybe we should remove the link entirely?

@potiuk potiuk merged commit 64c2a56 into apache:main Aug 13, 2023
42 checks passed
ferruzzi added a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Aug 17, 2023
* D205 Support - WWW

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

* fix broken link

(cherry picked from commit 64c2a56)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:API Airflow's REST/HTTP API area:webserver Webserver related Issues 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