-
Notifications
You must be signed in to change notification settings - Fork 14.6k
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
Enable enforcing pydocstyle rule D213 in ruff. #40448
Merged
Merged
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
ferruzzi
requested review from
bolkedebruin,
jedcunningham,
ephraimbuddy,
dstandish,
potiuk,
mik-laj,
hussein-awala,
eladkal,
mobuchowski,
josh-fell,
o-nikolas,
uranusjr,
jhtimmins,
ryanahamilton,
ashb,
bbovenzi,
pierrejeambrun,
kaxil and
XD-DENG
as code owners
June 26, 2024 23:04
boring-cyborg
bot
added
area:API
Airflow's REST/HTTP API
area:CLI
area:db-migrations
PRs with DB migration
area:Executors-core
LocalExecutor & SequentialExecutor
area:Scheduler
including HA (high availability) scheduler
labels
Jun 26, 2024
potiuk
approved these changes
Jun 27, 2024
potiuk
approved these changes
Jun 27, 2024
hussein-awala
approved these changes
Jun 27, 2024
eladkal
approved these changes
Jun 27, 2024
vincbeck
approved these changes
Jun 27, 2024
jedcunningham
approved these changes
Jun 27, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did the same change locally with ruff and compared to this branch - no other changes in here.
jedcunningham
added a commit
to astronomer/airflow
that referenced
this pull request
Jun 27, 2024
These were added into main after apache#40448 branched off.
jedcunningham
added a commit
that referenced
this pull request
Jun 27, 2024
These were added into main after #40448 branched off.
utkarsharma2
added
the
type:misc/internal
Changelog: Misc changes that should appear in change log
label
Jul 1, 2024
20 tasks
romsharon98
pushed a commit
to romsharon98/airflow
that referenced
this pull request
Jul 26, 2024
romsharon98
pushed a commit
to romsharon98/airflow
that referenced
this pull request
Jul 26, 2024
These were added into main after apache#40448 branched off.
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:CLI
area:db-migrations
PRs with DB migration
area:Executors-core
LocalExecutor & SequentialExecutor
area:Scheduler
including HA (high availability) scheduler
type:misc/internal
Changelog: Misc changes that should appear in change log
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.
Currently we have rules D212 and D213 on the ruff ignore list in pyproject,toml. They are conflicting rules and I want to propose that we work towards enabling one of them. In a nutshell:
Personally, I always use D213 style when I write multiline doc strings and I find it easier on the eyes. When I enabled it and ran static checks, ruff actually auto-fixed all instances so this is an easy one to enable if we want to.
Changes
pyproject.toml
- Manually moved D213 from the exclude list to the run list and added the comments about conflicting rules.Related: #10742
^ 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.rst
or{issue_number}.significant.rst
, in newsfragments.