Added variable descriptions to dataclass variables - #4591
Open
j-a-foster wants to merge 3 commits into
Open
Conversation
6 tasks
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4591 +/- ##
==========================================
+ Coverage 49.90% 50.05% +0.14%
==========================================
Files 151 151
Lines 29864 29940 +76
==========================================
+ Hits 14904 14986 +82
+ Misses 14960 14954 -6 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
timothy-nunn
requested changes
Sep 10, 2026
timothy-nunn
left a comment
Collaborator
There was a problem hiding this comment.
Just a few style comments
|
|
||
|
|
||
| @dataclass(slots=True) | ||
| class CICCIntegerTurnGeometry(TFGeneralTurnGeometry): |
Collaborator
There was a problem hiding this comment.
Not a comment for you Jack, I think this class can inherit from CICCAveragedTurnGeometry which will reduce duplication. Will make an issue.
chris-ashe
reviewed
Sep 10, 2026
Comment on lines
+2292
to
+2293
| """Cable space area (per turn) [m2] | ||
| Includes the area that would be taken up by voids and central cooling channel |
Collaborator
There was a problem hiding this comment.
Suggested change
| """Cable space area (per turn) [m2] | |
| Includes the area that would be taken up by voids and central cooling channel | |
| """Cable space area (per turn), includes the area that would be taken up by voids and central cooling channel [m²] |
Collaborator
Author
There was a problem hiding this comment.
Had to split between two lines as it was too long, check you're happy with it.
chris-ashe
requested changes
Sep 10, 2026
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
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
Missing variable desriptions have been added to variables in
superconducting.pydata classes.Replaces #4554 as there were rebasing issues.
Checklist
I confirm that I have completed the following checks: