Skip to content

Add hergQC docstrings#81

Merged
MichaelClerx merged 18 commits intomainfrom
hergQC-docstring
Nov 11, 2025
Merged

Add hergQC docstrings#81
MichaelClerx merged 18 commits intomainfrom
hergQC-docstring

Conversation

@MichaelClerx
Copy link
Copy Markdown
Member

@MichaelClerx MichaelClerx commented Oct 17, 2025

Part of #60

  • Added docstrings for hergQC module
  • Removed unused options in qc2, qc3, and qc5_1
  • Made always-used arguments in qc5 and qc6 non-optional
  • Removed unused/unnecessary getters and setters in hergQC
  • Updated test that was assuming x[0:-1] captures the whole trace (when in fact it misses out the final entry). See Make QCX methods callable stand-alone #97
  • Consistent string quotes

@MichaelClerx MichaelClerx marked this pull request as ready for review November 4, 2025 18:35
@MichaelClerx
Copy link
Copy Markdown
Member Author

Note that the syntax of these docstrings isn't right, or checked, at the moment, because we haven't set up documentation yet --> this will be fixed in #60 so sticking with imperfect docstrings for now

@MichaelClerx MichaelClerx changed the title Adding hergQC docstrings hergQC docstrings Nov 11, 2025
@MichaelClerx MichaelClerx changed the title hergQC docstrings Add hergQC docstrings Nov 11, 2025
Copy link
Copy Markdown
Collaborator

@joeyshuttleworth joeyshuttleworth left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks

@codecov
Copy link
Copy Markdown

codecov Bot commented Nov 11, 2025

Codecov Report

❌ Patch coverage is 89.42308% with 11 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.73%. Comparing base (eeb6f11) to head (7300038).
⚠️ Report is 19 commits behind head on main.

Files with missing lines Patch % Lines
pcpostprocess/hergQC.py 88.00% 9 Missing ⚠️
tests/test_herg_qc.py 93.10% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #81      +/-   ##
==========================================
+ Coverage   90.52%   91.73%   +1.21%     
==========================================
  Files          11       11              
  Lines         918      871      -47     
==========================================
- Hits          831      799      -32     
+ Misses         87       72      -15     

☔ 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.

@MichaelClerx MichaelClerx merged commit 36d3eac into main Nov 11, 2025
7 of 8 checks passed
@MichaelClerx MichaelClerx deleted the hergQC-docstring branch November 11, 2025 18:20
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.

2 participants