Add D400 pydocstyle check #31742
Merged
Add D400 pydocstyle check #31742
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vincbeck
requested review from
eladkal,
o-nikolas,
jedcunningham,
potiuk,
mik-laj,
ryanahamilton,
ashb,
bbovenzi,
pierrejeambrun,
kaxil and
XD-DENG
as code owners
boring-cyborg
bot
added
provider:cncf-kubernetes
vincbeck
commented
Jun 6, 2023
| @@ -38,7 +38,8 @@ extend-exclude = [ | |||
| "airflow/providers/google/ads/_vendor/*", | |||
| # The files generated by stubgen aren't 100% valid syntax it turns out, and we don't ship them, so we can | |||
| # ignore them in ruff | |||
| "airflow/providers/common/sql/*/*.pyi" | |||
| "airflow/providers/common/sql/*/*.pyi", | |||
| "airflow/migrations/versions/*.py" | |||
There was a problem hiding this comment.
Following up on this comment. These migration files are generated automatically by alembic. I could not find a way to configure alembic to generate D400 compatible docstring. Since these files are automatically generated, I think it is fine to exclude them from this check
uranusjr
approved these changes
Jun 6, 2023
pierrejeambrun
approved these changes
Jun 7, 2023
potiuk
added a commit
to potiuk/airflow
that referenced
this pull request
Jun 7, 2023
The apache#31359 and apache#31742 were merged independently and the first one did not have the fixes enabled by the second. This PR fixes it.
eladkal
added
changelog:skip
eladkal
added
the
type:misc/internal
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add D400 pydocstyle check.
This PR finally enables the D400 pydocstyle check. Most of the changes have been already done and merged in multiple PRs:
Resolves one item of #10742.
Once this PR merged, it might cause main to fail if in flight PRs are merged without rebasing.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in newsfragments.