Adding descriptions to two impl tags #2418
Open
Conversation
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
opotowsky
reviewed
Jan 9, 2026
Member
opotowsky
left a comment
opotowsky
left a comment
There was a problem hiding this comment.
I'm not strong on the reword, just a thought.
armi/reactor/blocks.py
Outdated
Comment on lines
1849
to
1850
| This method assumes you are rotating something on a hexagonal grid, and do not want to break the 60-degree | ||
| symmetry of the grid. It first determines how many times you want to rotate the block based on the 60-degree |
Member
There was a problem hiding this comment.
Suggested reword for the first two sentences:
This method rotates a block on a hexagonal grid, conserving the 60-degree symmetry of the grid. It first determines how many rotations the block will undergo based on the 60-degree hex grid.
Co-authored-by: Arrielle Opotowsky <c-aopotowsky@terrapower.com>
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.
What is the change? Why is it being made?
The following two
impltags were found to not have descriptions:I_ARMI_ROTATE_HEX_BLOCKI_ARMI_ROTATE_HEX_BURNUPThat is obviously no good. This PR fixes that and closes #2416
SCR Information
Change Type: docs
One-Sentence Rationale: Requirement implementation tags should have description fields.
One-line Impact on Requirements: The implementation tags
I_ARMI_ROTATE_HEX_BLOCKandI_ARMI_ROTATE_HEX_BURNUPwere both missing descriptions, and those were added. This is a documentation-only change, that does not impact the related requirements.Checklist
docfolder.pyproject.toml.