Skip to content

Commit 59e1633

Browse files
committed
Some editorial and grammatical fixes
1 parent c685041 commit 59e1633

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

armi/reactor/blueprints/componentBlueprint.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -193,11 +193,11 @@ def construct(self, blueprint, matMods):
193193
:implements: R_ARMI_MAT_USER_INPUT
194194
195195
Allows for user input to impact a component's materials by applying
196-
the ``material modifications`` section of a blueprints file (see :need:`I_ARMI_MAT_USER_INPUT0`)
197-
to the material during constructions. This takes place during lower
196+
the "material modifications" section of a blueprints file (see :need:`I_ARMI_MAT_USER_INPUT0`)
197+
to the material during construction. This takes place during lower
198198
calls to ``_conformKwargs()`` and subsequently ``_constructMaterial()``,
199-
which is passed in the component blueprint and the associated material
200-
modifications for the block that the component belongs to.
199+
which operate using the component blueprint and associated material
200+
modifications from the component's block.
201201
202202
Within ``_constructMaterial()``, the material class is resolved into a material
203203
object by calling :py:func:`~armi.materials.resolveMaterialClassByName`.
@@ -337,7 +337,7 @@ def insertDepletableNuclideKeys(c, blueprint):
337337
:id: I_ARMI_BP_NUC_FLAGS0
338338
:implements: R_ARMI_BP_NUC_FLAGS
339339
340-
This called during the component construction process for each component from within
340+
This is called during the component construction process for each component from within
341341
:py:meth:`~armi.reactor.blueprints.componentBlueprint.ComponentBlueprint.construct`.
342342
343343
For a given initialized component, check its flags to determine if it

armi/reactor/blueprints/gridBlueprint.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,15 +148,15 @@ class GridBlueprint(yamlize.Object):
148148
:id: I_ARMI_BP_GRID
149149
:implements: R_ARMI_BP_GRID
150150
151-
Defines a yaml construct that allows the user to define a grid
151+
Defines a yaml construct that allows the user to specify a grid
152152
from within their blueprints file, including a name, geometry, dimensions,
153-
symmetry, and a map specifying the relative locations of components within that grid.
153+
symmetry, and a map with the relative locations of components within that grid.
154154
155155
Relies on the underlying infrastrature from the ``yamlize`` package for
156156
reading from text files, serialization, and internal storage of the data.
157157
158158
Is implemented as part of a blueprints file by being used in key-value pairs
159-
within the :py:class:~`armi.reactor.blueprints.gridBlueprint.Grid` class,
159+
within the :py:class:`~armi.reactor.blueprints.gridBlueprint.Grid` class,
160160
which is imported and used as an attribute within the larger :py:class:`~armi.reactor.blueprints.Blueprints`
161161
class.
162162

armi/reactor/blueprints/isotopicOptions.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,11 +181,11 @@ class CustomIsotopic(yamlize.Map):
181181
reading from text files, serialization, and internal storage of the data.
182182
183183
Is implemented as part of a blueprints file by being used in key-value pairs
184-
within the :py:class:~`armi.reactor.blueprints.isotopicOptions.CustomIsotopics` class,
184+
within the :py:class:`~armi.reactor.blueprints.isotopicOptions.CustomIsotopics` class,
185185
which is imported and used as an attribute within the larger :py:class:`~armi.reactor.blueprints.Blueprints`
186186
class.
187187
188-
These isotopics are linked to a component during calls to :py:meth:`~armi.reactor.blueprints.componentBlueprint.ComponentBlueprint.apply`,
188+
These isotopics are linked to a component during calls to :py:meth:`~armi.reactor.blueprints.componentBlueprint.ComponentBlueprint.construct`,
189189
where the name specified in the ``isotopics`` attribute of the component blueprint
190190
is searched against the available ``CustomIsotopics`` defined in the
191191
"custom isotopics" section of the blueprints.

armi/reactor/blueprints/reactorBlueprint.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class SystemBlueprint(yamlize.Object):
4949
"""
5050
The reactor-level structure input blueprint.
5151
52-
.. impl:: Build core and spent fuel pool from blueprint
52+
.. impl:: Build core and spent fuel pool from blueprints
5353
:id: I_ARMI_BP_SYSTEMS
5454
:implements: R_ARMI_BP_SYSTEMS, R_ARMI_BP_CORE
5555
@@ -61,13 +61,13 @@ class SystemBlueprint(yamlize.Object):
6161
which is in turn included into the overall blueprints within
6262
:py:class:`~armi.reactor.blueprints.Blueprints`.
6363
64-
This class includes an :py:meth:`~armi.reactor.blueprints.reactorBlueprint.SystemBlueprint.construct`
64+
This class includes a :py:meth:`~armi.reactor.blueprints.reactorBlueprint.SystemBlueprint.construct`
6565
method, which is typically called from within :py:func:`~armi.reactor.reactors.factory`
6666
during the initialization of the reactor object to instantiate the core
6767
and/or spent fuel pool objects. During that process, a spatial grid is
6868
constructed based on the grid blueprints specified in the "grids" section
6969
of the blueprints (see :need:`I_ARMI_BP_GRID`) and the assemblies needed
70-
to fill that lattice are built from blueprints using :py:meth:`~armi.reactor.blueprints.Blueprints.constructAssem`.
70+
to fill the lattice are built from blueprints using :py:meth:`~armi.reactor.blueprints.Blueprints.constructAssem`.
7171
7272
.. note:: We use string keys to link grids to objects that use them. This differs
7373
from how blocks/assembies are specified, which use YAML anchors. YAML anchors

0 commit comments

Comments
 (0)