Apply suggestions from code review

Co-authored-by: John Stilley <[email protected]>
terrapower · Dec 2, 2024 · 40754b2 · 40754b2
1 parent 159f476
commit 40754b2
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/armi/physics/fuelCycle/hexAssemblyFuelMgmtUtils.py b/armi/physics/fuelCycle/hexAssemblyFuelMgmtUtils.py
@@ -34,9 +34,9 @@
 
 def getOptimalAssemblyOrientation(a: "HexAssembly", aPrev: "HexAssembly") -> int:
     """
-    Get optimal assembly orientation/rotation to minimize peak burnup.
+    Get optimal hex assembly orientation/rotation to minimize peak burnup.
 
-    .. impl:: Provide an algoritm for rotating hexagonal assemblies to equalize burnup
+    .. impl:: Provide an algorithm for rotating hexagonal assemblies to equalize burnup
         :id: I_ARMI_ROTATE_HEX_BURNUP
         :implements: R_ARMI_ROTATE_HEX_BURNUP
 
@@ -66,7 +66,7 @@ def getOptimalAssemblyOrientation(a: "HexAssembly", aPrev: "HexAssembly") -> int
     expected pin power. We evaluated "expected pin power" based on the power distribution in
     ``aPrev``, the previous assembly located where ``a`` is going. The algorithm goes as follows.
 
-    1. Get all the pin powers and ``IndexLocation``s from the block at the previous location.
+    1. Get all the pin powers and ``IndexLocation``s from the block at the previous location/timenode.
     2. Obtain the ``IndexLocation`` of the pin with the highest burnup in the current assembly.
     3. For each possible rotation,
         - Find the new location with ``HexGrid.rotateIndex``

diff --git a/doc/release/0.5.rst b/doc/release/0.5.rst
@@ -81,7 +81,7 @@ API Changes
 #. History Tracker: "detail assemblies" are now fuel and control assemblies. (`PR#1990 <https://github.com/terrapower/armi/pull/1990>`_)
 #. Removing ``Block.breakFuelComponentsIntoIndividuals()``. (`PR#1990 <https://github.com/terrapower/armi/pull/1990>`_)
 #. Moving ``getPuMoles`` from blocks.py up to composites.py. (`PR#1990 <https://github.com/terrapower/armi/pull/1990>`_)
-#. ``buReducingAssemblyRotation`` and ``getOptimalAssemblyOrientation`` require pin level burnup. (`PR#2019 <https://github.com/terrapower/armi/pull/2019>`_)
+#. Requiring ``buReducingAssemblyRotation`` and ``getOptimalAssemblyOrientation`` to have pin-level burnup. (`PR#2019 <https://github.com/terrapower/armi/pull/2019>`_)
 
 Bug Fixes
 ---------