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

Add "A" and "D" checks to ruff config #2641

Merged
merged 4 commits into from
Nov 28, 2023
Merged

Conversation

mraspaud
Copy link
Member

@mraspaud mraspaud commented Nov 21, 2023

This PR adds "A" (builtin shadowing) and "D" checks (pydocstyle) to ruff config.

Rule A003 has been set to "ignore" because it would require a significant amount of work to change "id" with something else in the composite objects.

Rule D417 has been set to "ignore" because it wasn't enforced before and it requires deeper understanding of the underlying functions to resolve. I would be nice to have in the future though:
https://docs.astral.sh/ruff/rules/undocumented-param/

@mraspaud mraspaud added the cleanup Code cleanup but otherwise no change in functionality label Nov 21, 2023
@mraspaud mraspaud self-assigned this Nov 21, 2023
@mraspaud mraspaud added this to the v0.45.0 milestone Nov 21, 2023
Copy link

codecov bot commented Nov 21, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5ecf1ab) 95.21% compared to head (33f354f) 95.21%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2641   +/-   ##
=======================================
  Coverage   95.21%   95.21%           
=======================================
  Files         356      356           
  Lines       51591    51591           
=======================================
  Hits        49120    49120           
  Misses       2471     2471           
Flag Coverage Δ
behaviourtests 4.22% <53.84%> (ø)
unittests 95.83% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mraspaud mraspaud changed the title Add "D" checks to ruff config Add "A" and "D" checks to ruff config Nov 21, 2023
@coveralls
Copy link

Pull Request Test Coverage Report for Build 6940911214

  • 65 of 65 (100.0%) changed or added relevant lines in 32 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 95.783%

Totals Coverage Status
Change from base Build 6938939151: 0.0%
Covered Lines: 49246
Relevant Lines: 51414

💛 - Coveralls

Copy link
Member

@sfinkens sfinkens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM!

@mraspaud mraspaud merged commit ed220be into pytroll:main Nov 28, 2023
17 of 19 checks passed
@mraspaud mraspaud deleted the add-ruff-D branch November 28, 2023 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Code cleanup but otherwise no change in functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants