Patch #90 (pep8 issues, docstring consistency) #92
Conversation
This file contains 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
yardasol
changed the title
LukeSeifert
reviewed
Jan 5, 2022
Comment on lines
+171
to
+179
| exec_path : str | ||
| Path to Serpent2 executable. | ||
| template_path : str | ||
| Path to user input file for Serpent2. | ||
| input_path : str | ||
| Name of input file for Serpent2 rerunning. | ||
| iter_matfile : str | ||
| Name of iterative, rewritable material file for Serpent2 | ||
| rerunning. This file is modified during the simulation. |
There was a problem hiding this comment.
Consider adding the optional tag to these parameters
There was a problem hiding this comment.
I don't think these are optional. They form the backbone of inputs that saltproc needs to run. What's your rationale?
There was a problem hiding this comment.
I was thinking the default values would typically work, but yeah I think you're right that these aren't really optional.
saltproc/depcode.py
Outdated
Comment on lines
328
to
334
| Parameters | ||
| ----------- | ||
| input_file: str | ||
| input_file : str | ||
| Serpent2 input file name and path. | ||
|
|
||
| Returns | ||
| -------- |
There was a problem hiding this comment.
There is one extra "-" on the Parameters and the Returns sections
| @@ -186,25 +199,25 @@ def __init__(self, | |||
| active_cycles, | |||
| inactive_cycles) | |||
|
|
|||
| def change_sim_par(self, data): | |||
| def change_sim_par(self, template_data): | |||
There was a problem hiding this comment.
template_data is a much better variable name, nice work
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.
Summary of changes
#90 had some pep8 issues and docstring inconsistencies that were not addressed before merging. This PR addresses those issues.
Types of changes
Required for Merging
Associated Issues and PRs
docadditions, docstring typo fixes, cross section processing scripts #90Associated Developers
Checklist for Reviewers
Reviewers should use this link to get to the
Review Checklist before they begin their review.