Skip to content

Improve_quality_fixes: missing docstrings, and raised exceptions missing from docstrings PART 1 - #4462

Merged
je-cook merged 11 commits into
mainfrom
improve_quality_fixes
Jul 30, 2026
Merged

Improve_quality_fixes: missing docstrings, and raised exceptions missing from docstrings PART 1#4462
je-cook merged 11 commits into
mainfrom
improve_quality_fixes

Conversation

@clmould

@clmould clmould commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

Description

Some more improve_quality_fixes - currently focussing on missing docstrings, and raised exceptions missing from docstrings

Having to leave some:
Missing ProcessValueError in peak_b_field_at_pf_coil - from the way this error is currently written, I can't determine concisely why it is being raised (#4467 should make the ProcessValueError clearer, then this can be documented in the docstring)

Missing BadParameter in process_cli - if I included this in the docstring, it would appear in the process --help menu

Leaving scan.py alone due to scan pr #4482

This PR has worked on:
examples/
process/core/io/vary_run
process/core/solver
process/core (not in any sub folder)
process/models/
tests/
tracking/

Checklist

I confirm that I have completed the following checks:

  • My changes follow the PROCESS style guide
  • I have justified any large differences in the regression tests caused by this pull request in the comments.
  • I have added new tests where appropriate for the changes I have made.
  • If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
  • If I have made documentation changes, I have checked they render correctly.
  • I have added documentation for my change, if appropriate.

@clmould
clmould force-pushed the improve_quality_fixes branch from 12e6870 to d7b6c83 Compare July 23, 2026 17:44
@codecov-commenter

codecov-commenter commented Jul 23, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 93.93939% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 48.76%. Comparing base (83d9f63) to head (8a22619).
⚠️ Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
process/models/tfcoil/superconducting.py 88.88% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4462      +/-   ##
==========================================
+ Coverage   48.67%   48.76%   +0.08%     
==========================================
  Files         151      151              
  Lines       29734    29782      +48     
==========================================
+ Hits        14474    14524      +50     
+ Misses      15260    15258       -2     

☔ View full report in Codecov by Harness.
📢 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.

@clmould
clmould force-pushed the improve_quality_fixes branch from f5737c1 to 1b831b9 Compare July 23, 2026 17:57
Comment thread process/models/superconductors.py
@clmould
clmould force-pushed the improve_quality_fixes branch from 143ca08 to 3c4e260 Compare July 28, 2026 16:45
@clmould clmould changed the title Improve_quality_fixes: missing docstrings, and raised exceptions missing from docstrings Improve_quality_fixes: missing docstrings, and raised exceptions missing from docstrings PART 1 Jul 29, 2026
@clmould
clmould marked this pull request as ready for review July 29, 2026 16:35
@clmould
clmould requested a review from a team as a code owner July 29, 2026 16:35
@je-cook
je-cook merged commit a9db119 into main Jul 30, 2026
10 of 11 checks passed
@je-cook
je-cook deleted the improve_quality_fixes branch July 30, 2026 07:35
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