Skip to content

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 modules:

  • airflow/main.py
  • airflow/configuration.py
  • airflow/policies.py
  • airflow/sentry.py
  • helm_tests/other/test_keda.py
  • setup.py

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 list above should be on the list. After re-commenting that line and re-running pre-commits, there should be zero regressions.

@potiuk potiuk merged commit 5e1e5fa into apache:main Aug 13, 2023
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
(cherry picked from commit 5e1e5fa)
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.

3 participants