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's D code for docstrings #428

Merged
merged 3 commits into from
Sep 5, 2024
Merged

🚨 enable ruff's D code for docstrings #428

merged 3 commits into from
Sep 5, 2024

Conversation

burgholzer
Copy link
Member

Description

This PR (finally) enables ruff's D code for pydocstyle lint rules.
Consequently, it fixes all the resulting warnings.
Additionally, it adds rules for favoring collections.abc over typing where appropriate.

Checklist:

  • The pull request only contains commits that are related to it.
  • I have added appropriate tests and documentation.
  • I have made sure that all CI jobs on GitHub pass.
  • The pull request introduces no new warnings and follows the project's style guidelines.

@burgholzer burgholzer self-assigned this Sep 5, 2024
@burgholzer burgholzer added documentation Improvements or additions to documentation python Pull requests that update Python code code quality Anything related to code quality and code style. labels Sep 5, 2024
@burgholzer burgholzer enabled auto-merge (squash) September 5, 2024 17:20
@burgholzer burgholzer merged commit 6f50e16 into main Sep 5, 2024
24 checks passed
@burgholzer burgholzer deleted the ruff branch September 5, 2024 18:07
Copy link

codecov bot commented Sep 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.3%. Comparing base (043d484) to head (11913d9).
Report is 62 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##            main    #428     +/-   ##
=======================================
- Coverage   92.3%   92.3%   -0.1%     
=======================================
  Files         37      37             
  Lines       2720    2719      -1     
  Branches     304     304             
=======================================
- Hits        2512    2511      -1     
  Misses       208     208             
Flag Coverage Δ *Carryforward flag
cpp 94.1% <ø> (ø) Carriedforward from 043d484
python 87.4% <100.0%> (-0.1%) ⬇️

*This pull request uses carry forward flags. Click here to find out more.

Files with missing lines Coverage Δ
src/mqt/ddsim/__init__.py 100.0% <ø> (ø)
src/mqt/ddsim/deterministicnoisesimulator.py 100.0% <ø> (ø)
src/mqt/ddsim/header.py 100.0% <ø> (ø)
src/mqt/ddsim/hybridqasmsimulator.py 90.9% <ø> (ø)
src/mqt/ddsim/hybridstatevectorsimulator.py 100.0% <ø> (ø)
src/mqt/ddsim/job.py 59.3% <100.0%> (ø)
src/mqt/ddsim/pathqasmsimulator.py 51.3% <ø> (ø)
src/mqt/ddsim/pathstatevectorsimulator.py 100.0% <ø> (ø)
src/mqt/ddsim/primitives/estimator.py 93.2% <100.0%> (ø)
src/mqt/ddsim/primitives/sampler.py 100.0% <100.0%> (ø)
... and 6 more

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality Anything related to code quality and code style. documentation Improvements or additions to documentation python Pull requests that update Python code
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant