Improve_quality_fixes: missing docstrings, and raised exceptions missing from docstrings#4462
Draft
clmould wants to merge 7 commits into
Draft
Improve_quality_fixes: missing docstrings, and raised exceptions missing from docstrings#4462clmould wants to merge 7 commits into
clmould wants to merge 7 commits into
Conversation
clmould
force-pushed
the
improve_quality_fixes
branch
from
July 23, 2026 17:44
12e6870 to
d7b6c83
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4462 +/- ##
==========================================
+ Coverage 48.64% 48.68% +0.03%
==========================================
Files 151 151
Lines 29703 29724 +21
==========================================
+ Hits 14449 14470 +21
Misses 15254 15254 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
clmould
force-pushed
the
improve_quality_fixes
branch
from
July 23, 2026 17:57
f5737c1 to
1b831b9
Compare
je-cook
reviewed
Jul 24, 2026
| @@ -1125,15 +1137,7 @@ def calculate_croco_cable_geometry( | |||
| Returns | |||
| ------- | |||
| CroCoCableGeometry | |||
Collaborator
There was a problem hiding this comment.
You dont need the type here it will be autofilled by the function definition by ide's and docs
Suggested change
| CroCoCableGeometry | |
| : |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 --helpmenuChecklist
I confirm that I have completed the following checks: