Sweeping crumbs for grammatical fixes

terrapower · Nov 22, 2023 · 93606ce · 93606ce
1 parent a44e1c8
commit 93606ce
Show file tree

Hide file tree

Showing 44 changed files with 140 additions and 140 deletions.
diff --git a/armi/cases/tests/test_cases.py b/armi/cases/tests/test_cases.py
@@ -202,7 +202,7 @@ def test_run(self):
         """
         Test running a case.
 
-        .. test:: Generic mechanism to allow simulation runs
+        .. test:: There is a generic mechanism to allow simulation runs.
             :id: T_ARMI_CASE
             :tests: R_ARMI_CASE
         """
@@ -300,7 +300,7 @@ def test_checkInputs(self):
         """
         Test the checkInputs() method on a couple of cases.
 
-        .. test:: Test the checkInputs method.
+        .. test:: Check the ARMI inputs for consistency and validity.
             :id: T_ARMI_CASE_CHECK
             :tests: R_ARMI_CASE_CHECK
         """

diff --git a/armi/materials/__init__.py b/armi/materials/__init__.py
@@ -15,9 +15,9 @@
 """
 The material package defines compositions and material-specific properties.
 
-Properties in scope include temperature dependent thermo/mechanical properties 
+Properties in scope include temperature dependent thermo/mechanical properties
 (like heat capacity, linear expansion coefficients, viscosity, density),
-and material-specific nuclear properties that can't exist at the nuclide level 
+and material-specific nuclear properties that can't exist at the nuclide level
 alone (like :py:mod:`thermal scattering laws <armi.nucDirectory.thermalScattering>`).
 
 As the fundamental macroscopic building blocks of any physical object,
@@ -47,7 +47,7 @@
 
 def setMaterialNamespaceOrder(order):
     """
-    Set the material namespace order at the Python interpretter, global level.
+    Set the material namespace order at the Python interpreter, global level.
 
     .. impl:: Materials can be searched across packages in a defined namespace.
         :id: I_ARMI_MAT_NAMESPACE

diff --git a/armi/materials/tests/test_materials.py b/armi/materials/tests/test_materials.py
@@ -143,7 +143,7 @@ class MaterialFindingTests(unittest.TestCase):
     def test_findMaterial(self):
         """Test resolveMaterialClassByName() function.
 
-        .. test:: You can find a meterial by name.
+        .. test:: You can find a material by name.
             :id: T_ARMI_MAT_NAME
             :tests: R_ARMI_MAT_NAME
         """

diff --git a/armi/nucDirectory/tests/test_elements.py b/armi/nucDirectory/tests/test_elements.py
@@ -103,7 +103,7 @@ def test_element_isNaturallyOccurring(self):
         Uses RIPL definitions of naturally occurring. Protactinium is debated as naturally
         occurring. Yeah it exists as a U235 decay product but it's kind of pseudo-natural.
 
-        .. test:: Get elements by Z, to show if they are naturally occurring.
+        .. test:: Get elements by Z to show if they are naturally occurring.
             :id: T_ARMI_ND_ELEMENTS3
             :tests: R_ARMI_ND_ELEMENTS
         """
@@ -128,7 +128,7 @@ def test_abundancesAddToOne(self):
     def test_isHeavyMetal(self):
         """Get elements by Z.
 
-        .. test:: Get elements by Z, to show if they are heavy metals.
+        .. test:: Get elements by Z to show if they are heavy metals.
             :id: T_ARMI_ND_ELEMENTS4
             :tests: R_ARMI_ND_ELEMENTS
         """

diff --git a/armi/nuclearDataIO/cccc/geodst.py b/armi/nuclearDataIO/cccc/geodst.py
@@ -133,7 +133,7 @@ def readWrite(self):
         Logic to control which records will be present is here, which
         comes directly off the File specification.
 
-        .. impl:: Read and write GEODST files.
+        .. impl:: Tool to read and write GEODST files.
             :id: I_ARMI_NUCDATA_GEODST
             :implements: R_ARMI_NUCDATA_GEODST
         """

diff --git a/armi/operators/operator.py b/armi/operators/operator.py
@@ -73,7 +73,7 @@ class Operator:
 
     .. note:: The :doc:`/developer/guide` has some additional narrative on this topic.
 
-    .. impl:: An operator will have a reactor object, to communicate between plugins.
+    .. impl:: An operator will have a reactor object to communicate between plugins.
         :id: I_ARMI_OPERATOR_COMM
         :implements: R_ARMI_OPERATOR_COMM
 

diff --git a/armi/physics/neutronics/globalFlux/tests/test_globalFluxInterface.py b/armi/physics/neutronics/globalFlux/tests/test_globalFluxInterface.py
@@ -107,7 +107,7 @@ class TestGlobalFluxOptions(unittest.TestCase):
     """
     Tests for GlobalFluxOptions.
 
-    .. test:: Tests GlobalFluxOptions
+    .. test:: Tests GlobalFluxOptions.
         :id: T_ARMI_FLUX_OPTIONS
         :tests: R_ARMI_FLUX_OPTIONS
     """
@@ -170,7 +170,7 @@ def test_checkEnergyBalance(self):
         """
         Test energy balance check.
 
-        .. test:: Block-wise power is consistent with reactor data model power
+        .. test:: Block-wise power is consistent with reactor data model power.
             :id: T_ARMI_FLUX_CHECK_POWER
             :tests: R_ARMI_FLUX_CHECK_POWER
         """
@@ -218,7 +218,7 @@ def test_setTightCouplingDefaults(self):
     def test_getTightCouplingValue(self):
         """Test getTightCouplingValue returns the correct value for keff and type for power.
 
-        .. test:: Get k-eff or assembly-wise power for coupling interactions
+        .. test:: Return k-eff or assembly-wise power for coupling interactions.
             :id: T_ARMI_FLUX_COUPLING_VALUE
             :tests: R_ARMI_FLUX_COUPLING_VALUE
         """
@@ -367,7 +367,7 @@ def test_calcReactionRates(self):
         """
         Test that the reaction rate code executes and sets a param > 0.0.
 
-        .. test:: Return the reaction rates for a given ArmiObject
+        .. test:: Return the reaction rates for a given ArmiObject.
             :id: T_ARMI_FLUX_RX_RATES
             :tests: R_ARMI_FLUX_RX_RATES
 

diff --git a/armi/reactor/assemblies.py b/armi/reactor/assemblies.py
@@ -177,7 +177,7 @@ def add(self, obj: blocks.Block):
         The simple act of adding a block to an assembly fully defines the location of
         the block in 3-D.
 
-        .. impl:: Assemblies are made up of type Block
+        .. impl:: Assemblies are made up of type Block.
             :id: I_ARMI_ASSEM_BLOCKS
             :implements: R_ARMI_ASSEM_BLOCKS
 
@@ -224,7 +224,7 @@ def getLocation(self):
         siblings of a Core. In future, this will likely be re-implemented in terms of
         just spatialLocator objects.
 
-        .. impl:: Assembly location is retrievable
+        .. impl:: Assembly location is retrievable.
             :id: I_ARMI_ASSEM_POSI0
             :implements: R_ARMI_ASSEM_POSI
 
@@ -242,7 +242,7 @@ def coords(self):
         """Return the location of the assembly in the plane using cartesian global
         coordinates.
 
-        .. impl:: Assembly coordinates are retrievable
+        .. impl:: Assembly coordinates are retrievable.
             :id: I_ARMI_ASSEM_POSI1
             :implements: R_ARMI_ASSEM_POSI
         """
@@ -256,7 +256,7 @@ def getArea(self):
         The assumption is that all blocks in an assembly have the same area.
         Calculate the total assembly volume in cm^3.
 
-        .. impl:: Assembly area is retrievable
+        .. impl:: Assembly area is retrievable.
             :id: I_ARMI_ASSEM_DIMS0
             :implements: R_ARMI_ASSEM_DIMS
         """
@@ -271,7 +271,7 @@ def getArea(self):
     def getVolume(self):
         """Calculate the total assembly volume in cm^3.
 
-        .. impl:: Assembly volume is retrievable
+        .. impl:: Assembly volume is retrievable.
             :id: I_ARMI_ASSEM_DIMS1
             :implements: R_ARMI_ASSEM_DIMS
         """
@@ -475,7 +475,7 @@ def getTotalHeight(self, typeSpec=None):
         """
         Determine the height of this assembly in cm.
 
-        .. impl:: Assembly height is retrievable
+        .. impl:: Assembly height is retrievable.
             :id: I_ARMI_ASSEM_DIMS2
             :implements: R_ARMI_ASSEM_DIMS
 
@@ -1192,7 +1192,7 @@ def getDim(self, typeSpec, dimName):
 
         Example: getDim(Flags.WIRE, 'od') will return a wire's OD in cm.
 
-        .. impl:: Assembly dimensions are retrievable
+        .. impl:: Assembly dimensions are retrievable.
             :id: I_ARMI_ASSEM_DIMS3
             :implements: R_ARMI_ASSEM_DIMS
         """

diff --git a/armi/reactor/blocks.py b/armi/reactor/blocks.py
@@ -583,7 +583,7 @@ def adjustUEnrich(self, newEnrich):
     def getLocation(self):
         """Return a string representation of the location.
 
-        .. impl:: Location of a block is retrievable
+        .. impl:: Location of a block is retrievable.
             :id: I_ARMI_BLOCK_POSI0
             :implements: R_ARMI_BLOCK_POSI
         """
@@ -598,7 +598,7 @@ def coords(self, rotationDegreesCCW=0.0):
         """
         Returns the coordinates of the block.
 
-        .. impl:: Coordinates of a block are queryable
+        .. impl:: Coordinates of a block are queryable.
             :id: I_ARMI_BLOCK_POSI1
             :implements: R_ARMI_BLOCK_POSI
         """
@@ -682,7 +682,7 @@ def getVolume(self):
         """
         Return the volume of a block.
 
-        .. impl:: Volume of block is retrievable
+        .. impl:: Volume of block is retrievable.
             :id: I_ARMI_BLOCK_DIMS0
             :implements: R_ARMI_BLOCK_DIMS
 
@@ -1247,7 +1247,7 @@ def getPitch(self, returnComp=False):
             Component that has the max pitch, if returnComp == True. If no component is found to
             define the pitch, returns None
 
-        .. impl:: Pitch of block is retrievable
+        .. impl:: Pitch of block is retrievable.
             :id: I_ARMI_BLOCK_DIMS1
             :implements: R_ARMI_BLOCK_DIMS
 
@@ -1598,7 +1598,7 @@ class HexBlock(Block):
     """
     Defines a HexBlock.
 
-    .. impl:: Ability to create hex shaped blocks
+    .. impl:: ARMI has the ability to create hex shaped blocks.
         :id: I_ARMI_BLOCK_HEX
         :implements: R_ARMI_BLOCK_HEX
     """
@@ -1612,7 +1612,7 @@ def coords(self, rotationDegreesCCW=0.0):
         """
         Returns the coordinates of the block.
 
-        .. impl:: Coordinates of a block are queryable
+        .. impl:: Coordinates of a block are queryable.
             :id: I_ARMI_BLOCK_POSI2
             :implements: R_ARMI_BLOCK_POSI
         """
@@ -1628,7 +1628,7 @@ def _createHomogenizedCopy(self, pinSpatialLocators=False):
         """
         Create a new homogenized copy of a block that is less expensive than a full deepcopy.
 
-        .. impl:: Homogenize the compositions of a block
+        .. impl:: Block compositions can be homogenized.
             :id: I_ARMI_BLOCK_HOMOG
             :implements: R_ARMI_BLOCK_HOMOG
 
@@ -1713,7 +1713,7 @@ def getMaxArea(self):
         """
         Compute the max area of this block if it was totally full.
 
-        .. impl:: Area of block is retrievable
+        .. impl:: Area of block is retrievable.
             :id: I_ARMI_BLOCK_DIMS2
             :implements: R_ARMI_BLOCK_DIMS
         """
@@ -1726,7 +1726,7 @@ def getDuctIP(self):
         """
         Returns the duct IP dimension.
 
-        .. impl:: IP dimension is retrievable
+        .. impl:: IP dimension is retrievable.
             :id: I_ARMI_BLOCK_DIMS3
             :implements: R_ARMI_BLOCK_DIMS
         """
@@ -1737,7 +1737,7 @@ def getDuctOP(self):
         """
         Returns the duct OP dimension.
 
-        .. impl:: OP dimension is retrievable
+        .. impl:: OP dimension is retrievable.
             :id: I_ARMI_BLOCK_DIMS4
             :implements: R_ARMI_BLOCK_DIMS
         """
@@ -2041,7 +2041,7 @@ def getPinToDuctGap(self, cold=False):
         """
         Returns the distance in cm between the outer most pin and the duct in a block.
 
-        .. impl:: Pin to duct gap of block is retrievable
+        .. impl:: Pin to duct gap of block is retrievable.
             :id: I_ARMI_BLOCK_DIMS5
             :implements: R_ARMI_BLOCK_DIMS
 
@@ -2225,7 +2225,7 @@ def getPinPitch(self, cold=False):
         Assumes that the pin pitch is defined entirely by contacting cladding tubes
         and wire wraps. Grid spacers not yet supported.
 
-        .. impl:: Pin pitch within block is retrievable
+        .. impl:: Pin pitch within block is retrievable.
             :id: I_ARMI_BLOCK_DIMS6
             :implements: R_ARMI_BLOCK_DIMS
 
@@ -2262,7 +2262,7 @@ def getPinPitch(self, cold=False):
     def getWettedPerimeter(self):
         """Return the total wetted perimeter of the block in cm.
 
-        .. impl:: Wetted perimeter of block is retrievable
+        .. impl:: Wetted perimeter of block is retrievable.
             :id: I_ARMI_BLOCK_DIMS7
             :implements: R_ARMI_BLOCK_DIMS
         """
@@ -2340,7 +2340,7 @@ def getWettedPerimeter(self):
     def getFlowArea(self):
         """Return the total flowing coolant area of the block in cm^2.
 
-        .. impl:: Flow area of block is retrievable
+        .. impl:: Flow area of block is retrievable.
             :id: I_ARMI_BLOCK_DIMS8
             :implements: R_ARMI_BLOCK_DIMS
         """
@@ -2361,7 +2361,7 @@ def getHydraulicDiameter(self):
         p = sqrt(3)*s
         l = 6*p/sqrt(3)
 
-        .. impl:: Hydraulic diameter of block is retrievable
+        .. impl:: Hydraulic diameter of block is retrievable.
             :id: I_ARMI_BLOCK_DIMS9
             :implements: R_ARMI_BLOCK_DIMS
         """

diff --git a/armi/reactor/blueprints/assemblyBlueprint.py b/armi/reactor/blueprints/assemblyBlueprint.py
@@ -93,7 +93,7 @@ class AssemblyBlueprint(yamlize.Object):
     This class utilizes ``yamlize`` to enable serialization to and from the
     blueprints YAML file.
 
-    .. impl:: Create assembly from blueprint file
+    .. impl:: Create assembly from blueprint file.
         :id: I_ARMI_BP_ASSEM
         :implements: R_ARMI_BP_ASSEM
     """

diff --git a/armi/reactor/blueprints/blockBlueprint.py b/armi/reactor/blueprints/blockBlueprint.py
@@ -44,7 +44,7 @@ def _configureGeomOptions():
 class BlockBlueprint(yamlize.KeyedList):
     """Input definition for Block.
 
-    .. impl:: Create a Block from blueprint file
+    .. impl:: Create a Block from blueprint file.
         :id: I_ARMI_BP_BLOCK
         :implements: R_ARMI_BP_BLOCK
     """

diff --git a/armi/reactor/blueprints/componentBlueprint.py b/armi/reactor/blueprints/componentBlueprint.py
@@ -120,7 +120,7 @@ class ComponentBlueprint(yamlize.Object):
     This class defines the inputs necessary to build ARMI component objects. It uses ``yamlize`` to enable serialization
     to and from YAML.
 
-    .. impl:: Construct component from blueprint file
+    .. impl:: Construct component from blueprint file.
         :id: I_ARMI_BP_COMP
         :implements: R_ARMI_BP_COMP
     """

diff --git a/armi/reactor/blueprints/gridBlueprint.py b/armi/reactor/blueprints/gridBlueprint.py
@@ -248,7 +248,7 @@ def readFromLatticeMap(self, value):
     def construct(self):
         """Build a Grid from a grid definition.
 
-        .. impl:: Define a lattice map in reactor core
+        .. impl:: Define a lattice map in reactor core.
             :id: I_ARMI_BP_GRID
             :implements: R_ARMI_BP_GRID
         """
@@ -540,7 +540,7 @@ def saveToStream(stream, bluep, full=False, tryMap=False):
     tryMap: regardless of input form, attempt to output as a lattice map. let's face it;
     they're prettier.
 
-    .. impl:: Write a blueprint file from a blueprint object
+    .. impl:: Write a blueprint file from a blueprint object.
         :id: I_ARMI_BP_TO_DB
         :implements: R_ARMI_BP_TO_DB
     """

diff --git a/armi/reactor/blueprints/reactorBlueprint.py b/armi/reactor/blueprints/reactorBlueprint.py
@@ -105,7 +105,7 @@ def construct(self, cs, bp, reactor, geom=None, loadAssems=True):
             :id: I_ARMI_BP_SYSTEMS
             :implements: R_ARMI_BP_SYSTEMS
 
-        .. impl:: Create core object with blueprint
+        .. impl:: Create core object from blueprint.
             :id: I_ARMI_BP_CORE
             :implements: R_ARMI_BP_CORE
 

diff --git a/armi/reactor/blueprints/tests/test_assemblyBlueprints.py b/armi/reactor/blueprints/tests/test_assemblyBlueprints.py
@@ -186,7 +186,7 @@ def test_checkParamConsistency(self):
         """
         Load assembly from a blueprint file.
 
-        .. test:: Create assembly from blueprint file
+        .. test:: Create assembly from blueprint file.
             :id: T_ARMI_BP_ASSEM
             :tests: R_ARMI_BP_ASSEM
         """

diff --git a/armi/reactor/blueprints/tests/test_blockBlueprints.py b/armi/reactor/blueprints/tests/test_blockBlueprints.py
@@ -257,7 +257,7 @@
 class TestGriddedBlock(unittest.TestCase):
     """Tests for a block that has components in a lattice.
 
-    .. test:: Create block with blueprint file
+    .. test:: Create block with blueprint file.
         :id: T_ARMI_BP_BLOCK
         :tests: R_ARMI_BP_BLOCK
     """
@@ -309,7 +309,7 @@ def test_explicitFlags(self):
         """
         Test flags are created from blueprint file.
 
-        .. test:: Test depletable nuc flags
+        .. test:: Nuc flags can define depletable objects.
             :id: T_ARMI_BP_NUC_FLAGS
             :tests: R_ARMI_BP_NUC_FLAGS
         """