Skip to content

Introduction of informational pydoclint CI job on push and PR#446

Draft
emlynsg wants to merge 8 commits intoTeamGraphix:masterfrom
qat-inria:pydoclint
Draft

Introduction of informational pydoclint CI job on push and PR#446
emlynsg wants to merge 8 commits intoTeamGraphix:masterfrom
qat-inria:pydoclint

Conversation

@emlynsg
Copy link
Contributor

@emlynsg emlynsg commented Feb 18, 2026

Draft PR for presentation and discussion

This draft PR:

  • introduces a new job in the CI that runs pydoclint, and reports on failing lines in each file of the repository
  • adds to the pre-commit hook to include Ruff and a commented pydoclint step (to be reactivated when we have completed standardising the docstrings of the repository)
  • fixes docstrings/type annotations that were causing pydoclint to fail when run.

Note: The graphix-qasm-parser dependency was causing the CI to fail, and was commented out.

@codecov
Copy link

codecov bot commented Feb 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.39%. Comparing base (03a89c9) to head (3fd0957).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #446      +/-   ##
==========================================
- Coverage   88.76%   88.39%   -0.37%     
==========================================
  Files          44       44              
  Lines        6308     6308              
==========================================
- Hits         5599     5576      -23     
- Misses        709      732      +23     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

1 participant

Comments