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

D401 Support - Api to Auth (Inclusive) #33333

Merged
merged 1 commit into from
Aug 12, 2023

Conversation

ferruzzi
Copy link
Contributor

Part of #10742

D401 asserts "First line should be in imperative mood". This is a little opaque so upon further investigation what they want is:

[Docstring] prescribes the function or method's effect as a command: 
("Do this", "Return that"), not as a description; 
e.g. don't write "Returns the pathname ...".

There are over two thousand violations in the repo so I'm going 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 located in the following modules:

  • airflow/api
  • airflow/api_connexion
  • airflow/api_internal
  • airflow/auth

To test

If you uncomment this line and run pre-commit in main you will get literally thousands of errors. After these changes, no files in the list above should be on the list. After re-commenting that line and re-running pre-commits, there should be zero regressions.

@boring-cyborg boring-cyborg bot added the area:API Airflow's REST/HTTP API label Aug 12, 2023
@ferruzzi ferruzzi changed the title D401 Support - airflow/api thru airflow/auth (inclusive) D401 Support - Api thru Auth (inclusive) Aug 12, 2023
@ferruzzi ferruzzi changed the title D401 Support - Api thru Auth (inclusive) D401 Support - Api to Auth (inclusive) Aug 12, 2023
@ferruzzi ferruzzi changed the title D401 Support - Api to Auth (inclusive) D401 Support - Api to Auth (Inclusive) Aug 12, 2023
@potiuk potiuk merged commit b657ae9 into apache:main Aug 12, 2023
@potiuk
Copy link
Member

potiuk commented Aug 13, 2023

Hey @ferruzzi -> you likely missed that, but:

Screenshot 2023-08-13 at 20 03 57

ferruzzi added a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Aug 17, 2023
@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
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 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