Added variable descriptions to dataclass variables

[j-a-foster]

Description

Missing variable desriptions have been added to variables in superconducting.py data classes.

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.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 49.52%. Comparing base (a9358cc) to head (3109ed6).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4554      +/-   ##
==========================================
+ Coverage   49.46%   49.52%   +0.05%     
==========================================
  Files         150      150              
  Lines       30069    30102      +33     
==========================================
+ Hits        14874    14907      +33     
  Misses      15195    15195              

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

[mkovari]

These seem to be copies of the descriptions in process/data_structure/tfcoil_variables.py. Did you intend to duplicate these descriptions without deleting the originals?

[j-a-foster]

These seem to be copies of the descriptions in process/data_structure/tfcoil_variables.py. Did you intend to duplicate these descriptions without deleting the originals?

I've replicated what's been done for other dataclasses in the same file, they have descriptions which match or summarise what's in the corresponding _variables.py file. j_tf_wp_critical is one such variable that has a description in both superconducting.py and tfcoil_variables.py. Unless I'm missing something, I think they are supposed to be in both places?

[clmould]

These seem to be copies of the descriptions in process/data_structure/tfcoil_variables.py. Did you intend to duplicate these descriptions without deleting the originals?

I've replicated what's been done for other dataclasses in the same file, they have descriptions which match or summarise what's in the corresponding _variables.py file. j_tf_wp_critical is one such variable that has a description in both superconducting.py and tfcoil_variables.py. Unless I'm missing something, I think they are supposed to be in both places?

Yea the variables in these dataclasses need descriptions, as well as in the data_structure files - this way users can see the descriptions for the dataclass variables without having to search through data_structure files, but we still need the descriptions in the data structure for the dictionaries