Skip to content

Commit 956c51d

Browse files
authored
Adding some impl crumbs to docstrings (#1508)
1 parent 7de33eb commit 956c51d

File tree

3 files changed

+13
-0
lines changed

3 files changed

+13
-0
lines changed

armi/nuclearDataIO/xsCollections.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,7 @@ def __init__(
381381
def createMacrosOnBlocklist(
382382
self, microLibrary, blockList, nucNames=None, libType="micros"
383383
):
384+
"""Create macroscopic cross sections for a list of blocks."""
384385
for block in blockList:
385386
block.macros = self.createMacrosFromMicros(
386387
microLibrary, block, nucNames, libType=libType
@@ -788,6 +789,10 @@ def computeMacroscopicGroupConstants(
788789
"""
789790
Compute any macroscopic group constants given number densities and a microscopic library.
790791
792+
.. impl:: Compute macroscopic cross sections from microscopic cross sections and number densities.
793+
:id: I_ARMI_NUCDATA_MACRO
794+
:implements: R_ARMI_NUCDATA_MACRO
795+
791796
Parameters
792797
----------
793798
constantName : str

armi/physics/neutronics/macroXSGenerationInterface.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,10 @@ def buildMacros(
144144
Builds G-vectors of the basic XS ('nGamma','fission','nalph','np','n2n','nd','nt')
145145
Builds GxG matrices for scatter matrices
146146
147+
.. impl:: Build macroscopic cross sections for blocks.
148+
:id: I_ARMI_MACRO_XS
149+
:implements: R_ARMI_MACRO_XS
150+
147151
Parameters
148152
----------
149153
lib : library object , optional

armi/reactor/blocks.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1561,6 +1561,10 @@ def rotate(self, rad):
15611561
def setAxialExpTargetComp(self, targetComponent):
15621562
"""Sets the targetComponent for the axial expansion changer.
15631563
1564+
.. impl:: Set the target axial expansion components on a given block.
1565+
:id: I_ARMI_MANUAL_TARG_COMP
1566+
:implements: R_ARMI_MANUAL_TARG_COMP
1567+
15641568
Parameter
15651569
---------
15661570
targetComponent: :py:class:`Component <armi.reactor.components.component.Component>` object

0 commit comments

Comments
 (0)