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 - Sensors, Serialization, and Triggers #34932

Merged
merged 1 commit into from
Oct 17, 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 ...".

We started with 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 locations:

  • airflow/sensors
  • airflow/serialization
  • airflow/triggers

To test

If you uncomment this line and run pre-commit in main you will get over a thousand errors. After these changes, no files in the providers listed 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 area:core-operators Operators, Sensors and hooks within Core Airflow area:serialization area:Triggerer labels Oct 13, 2023
@ferruzzi ferruzzi added use public runners Makes sure that Public runners are used even if commiters creates the PR (useful for testing) and removed use public runners Makes sure that Public runners are used even if commiters creates the PR (useful for testing) labels Oct 13, 2023
@ferruzzi
Copy link
Contributor Author

Runners aren't picking it up. It's Friday evening... I'll let them get a rest and bump it on Monday :P

@Taragolis Taragolis merged commit ee9e00b into apache:main Oct 17, 2023
43 checks passed
@ephraimbuddy ephraimbuddy added the type:misc/internal Changelog: Misc changes that should appear in change log label Oct 27, 2023
@ephraimbuddy ephraimbuddy added this to the Airflow 2.7.3 milestone Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:core-operators Operators, Sensors and hooks within Core Airflow area:serialization 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.

5 participants