Skip to content

add missing docstrings to data_structure/ files - #4485

Merged
timothy-nunn merged 6 commits into
mainfrom
data_structure_docstrings
Aug 4, 2026
Merged

add missing docstrings to data_structure/ files#4485
timothy-nunn merged 6 commits into
mainfrom
data_structure_docstrings

Conversation

@clmould

@clmould clmould commented Jul 29, 2026

Copy link
Copy Markdown
Collaborator

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.

@clmould
clmould requested a review from a team as a code owner July 29, 2026 14:59
@clmould
clmould marked this pull request as draft July 29, 2026 15:04
@codecov-commenter

codecov-commenter commented Jul 29, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 49.21%. Comparing base (78d50cc) to head (8ee0854).
⚠️ Report is 12 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #4485      +/-   ##
==========================================
+ Coverage   48.73%   49.21%   +0.48%     
==========================================
  Files         151      151              
  Lines       29766    29667      -99     
==========================================
+ Hits        14505    14600      +95     
+ Misses      15261    15067     -194

☔ 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 marked this pull request as ready for review August 3, 2026 10:05
clmould
clmould commented Aug 3, 2026
View reviewed changes
Comment thread process/data_structure/blanket_variables.py
@@ -1,29 +1,4 @@
"""This library contains routines that can be shared by the blanket modules used in PROCESS.

@clmould clmould Aug 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Some of the var files had a huge chunk of text copied from their corresponding process/models file (which didn't make a huge amount of sense in the var file, i.e. mentioning functions or acronyms that are not used in the var file) so where I've deleted a large bit of text like this it is still in the code so not losing any info, but it tidies up the files a bit

timothy-nunn
timothy-nunn requested changes Aug 4, 2026
View reviewed changes
Comment thread process/data_structure/blanket_variables.py
Comment on lines -10 to -23
Acronyms for this module:

BB Breeding Blanket
FW First Wall
BZ Breeder Zone
MF/BSS Manifold/Back Supporting Structure
LT Low Temperature
HT High Temperature
MMS Multi Module Segment
SMS Single Module Segment
IB Inboard
OB Outboard
HCD Heating & Current Drive
FCI Flow Channel Insert

@timothy-nunn timothy-nunn Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Some of these acronyms are used below, might be worth keeping this bit

Comment thread process/data_structure/build_variables.py Outdated
@@ -1,3 +1,5 @@
"""Module containing variables relating to the build routines"""

@timothy-nunn timothy-nunn Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
"""Module containing variables relating to the build routines"""
"""Module containing variables for the build models"""

Can we find and replace to update the language like above, it feels a bit wordy at the moment.

If you cannot find a way message me and I'll write a little regex find and replace to do it.

Comment thread process/data_structure/dcll_variables.py
Comment on lines -5 to -18
Acronyms for this module:

BB Breeding Blanket
FW First Wall
BZ Breeder Zone
MF/BSS Manifold/Back Supporting Structure
LT Low Temperature
HT High Temperature
MMS Multi Module Segment
SMS Single Module Segment
IB Inboard
OB Outboard
HCD Heating & Current Drive
FCI Flow Channel Insert

@timothy-nunn timothy-nunn Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Again, I suspect these will be used below so might be best to keep them

@clmould
clmould requested a review from timothy-nunn August 4, 2026 13:47
timothy-nunn
timothy-nunn requested changes Aug 4, 2026
View reviewed changes
Comment thread process/data_structure/constraint_variables.py Outdated
Comment thread process/data_structure/neoclassics_variables.py Outdated
Comment thread process/data_structure/stellarator_configuration.py Outdated
clmould and others added 3 commits August 4, 2026 15:37
@clmould @timothy-nunn
Apply suggestion from @timothy-nunn
5ba3708 
Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>
@clmould @timothy-nunn
Apply suggestion from @timothy-nunn
263caa9 
Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>
@clmould @timothy-nunn
Update process/data_structure/neoclassics_variables.py
8ee0854 
Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>
@clmould
clmould requested a review from timothy-nunn August 4, 2026 15:29
@timothy-nunn
timothy-nunn merged commit d38596b into main Aug 4, 2026
11 checks passed
@timothy-nunn
timothy-nunn deleted the data_structure_docstrings branch August 4, 2026 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@timothy-nunn timothy-nunn timothy-nunn approved these changes

Assignees

@timothy-nunn timothy-nunn

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@clmould @codecov-commenter @timothy-nunn