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

Enable Ruff d200 rule #983

Open
wants to merge 1 commit into
base: enhancement/ruff-D-rule
Choose a base branch
from

Conversation

MarcSkovMadsen
Copy link
Collaborator

@MarcSkovMadsen MarcSkovMadsen commented Nov 23, 2024

Continues from #982. So review that one first.

I've re-renabled rule D200 in pyproject.toml and applied ruff check --unsafe-fixes.

Then checked the changes manually.

Copy link

codecov bot commented Nov 23, 2024

Codecov Report

Attention: Patch coverage is 54.54545% with 5 lines in your changes missing coverage. Please review.

Project coverage is 87.36%. Comparing base (1868240) to head (f2791e6).

Files with missing lines Patch % Lines
param/serializer.py 0.00% 5 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #983   +/-   ##
=======================================
  Coverage   87.35%   87.36%           
=======================================
  Files           9        9           
  Lines        4935     4938    +3     
=======================================
+ Hits         4311     4314    +3     
  Misses        624      624           

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


🚨 Try these New Features:

@MarcSkovMadsen MarcSkovMadsen changed the title Enhancement/ruff d200 rule Enable Ruff d200 rule Nov 23, 2024
@hoxbro hoxbro changed the base branch from main to enhancement/ruff-D-rule November 23, 2024 08:20
@maximlt
Copy link
Member

maximlt commented Nov 25, 2024

@MarcSkovMadsen in case it wasn't clear, I did not suggest to open one PR per rule:

I'm not necessarily saying one rule at a time. It's just I'd like to avoid having to review all the docstrings of the complete API at once, as it's a lot, and I'm quite sure there are a few traps along the way that could slow you down or even block you entirely if done in one PR, while if you iterate we can be much more efficient and release improvements quickly.

I think it's totally fine if you open one PR that enables multiple rules at the same time, specially if it's only about formatting. Things will get more challenging for reviewers as soon as you'll touch the real meat which is the content of the docstrings.

cc @hoxbro

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants