Skip to content

🐛 Update WP cross section area label to reflect total steel area …#3883

Merged
timothy-nunn merged 1 commit intomainfrom
bug_tf_wp_steel_fix
Oct 8, 2025
Merged

🐛 Update WP cross section area label to reflect total steel area …#3883
timothy-nunn merged 1 commit intomainfrom
bug_tf_wp_steel_fix

Conversation

@chris-ashe
Copy link
Copy Markdown
Collaborator

@chris-ashe chris-ashe commented Oct 3, 2025

This pull request makes a small update to the output labeling in the outtf method of tf_coil.py. The label for a particular variable has been clarified to better reflect its meaning, and the corresponding variable reference has been updated to match.

🐛 Bug

  • Changed the output label from "WP cross section area (per coil) (m2)" to "Total steel area in WP (per coil) (m2)" and updated the variable from a_tf_wp_no_insulation to a_tf_wp_steel in the outtf method of tf_coil.py…in TF coil output

Description

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.

@chris-ashe chris-ashe self-assigned this Oct 3, 2025
@chris-ashe chris-ashe added Bug TF Coil Toroidal field coil labels Oct 3, 2025
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Oct 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 46.45%. Comparing base (50cfc49) to head (a57a71f).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3883   +/-   ##
=======================================
  Coverage   46.45%   46.45%           
=======================================
  Files         123      123           
  Lines       28050    28050           
=======================================
  Hits        13030    13030           
  Misses      15020    15020           

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

@chris-ashe chris-ashe marked this pull request as ready for review October 6, 2025 08:33
Copy link
Copy Markdown
Collaborator

@timothy-nunn timothy-nunn left a comment

Choose a reason for hiding this comment

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

Does the description of the variable also need to be updated to agree with the output title?

a_tf_wp_steel: float = None
"""winding pack structure area (m2)"""

Some of the other _steel variables also seem to have generic/ no steel-specific descriptions

@chris-ashe chris-ashe force-pushed the bug_tf_wp_steel_fix branch from cf52d34 to a57a71f Compare October 8, 2025 14:25
@chris-ashe
Copy link
Copy Markdown
Collaborator Author

Does the description of the variable also need to be updated to agree with the output title?

a_tf_wp_steel: float = None
"""winding pack structure area (m2)"""

Some of the other _steel variables also seem to have generic/ no steel-specific descriptions

Have re-done that variable description and one other

@timothy-nunn timothy-nunn merged commit 1f360a6 into main Oct 8, 2025
20 of 27 checks passed
@timothy-nunn timothy-nunn deleted the bug_tf_wp_steel_fix branch October 8, 2025 15:15
@je-cook je-cook added the Bug Something isnt working label Jan 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something isnt working TF Coil Toroidal field coil

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants