Cleaning up some casual docstrings (#2048)

armi/apps.py

@@ -18,15 +18,6 @@
 This module defines the :py:class:`App` class, which is used to configure the ARMI
 Framework for a specific application. An ``App`` implements a simple interface for
 customizing much of the Framework's behavior.
-
-Notes
------
-Historical Fun Fact
-
-This pattern is used by many frameworks as a way of encapsulating what would otherwise be global
-state. The ARMI Framework has historically made heavy use of global state (e.g.,
-:py:mod:`armi.nucDirectory.nuclideBases`), and it will take quite a bit of effort to refactor the
-code to access such things through an App object.
 """
 # ruff: noqa: E402
 import collections

armi/mpiActions.py

@@ -469,7 +469,7 @@ def invokeHook(self):
         actionResult = None
         try:
             action = mpiComm.scatter(self._actions, root=0)
-            # create a new communicator that only has these specific dudes running
+            # create a new communicator that only has these specific processes running
             hasAction = action is not None
             context.MPI_COMM = mpiComm.Split(int(hasAction))
             context.MPI_RANK = context.MPI_COMM.Get_rank()

armi/nuclearDataIO/cccc/isotxs.py

@@ -753,8 +753,9 @@ def _getScatterMatrix(self, blockNumIndex):
         """
         Get the scatter matrix for a particular blockNum.
 
-        Note: This is stupid and the logic should be combined with _setScatterMatrix.
-        Please recommend a better way to do it during code review.
+        Notes
+        -----
+        This logic could be combined with _setScatterMatrix.
         """
         if blockNumIndex == self._getElasticScatterBlockNumIndex():
             scatterMatrix = self._getMicros().elasticScatter

armi/physics/__init__.py

@@ -69,13 +69,4 @@
 And then the associated ARMI-based app could import both ``IAEA.physics.neutronics.superSourceTerm`` and
 ``IAEA.physics.economics.magwoodsbrain``. Having a consistency in namespace along these lines is
 quite nice.
-
-If you want to propose a new namespace root folder here, we recommend making a ticket to aid in the discussion.
-
-
-.. admonition:: Historical fun fact
-
-    **All** physics modules once actually lived in this package,
-    before the age of Plugins began. The current state is transient, and will
-    converge as the framework matures.
 """

armi/physics/fuelCycle/fuelHandlers.py

@@ -278,12 +278,11 @@ def findAssembly(
             multiplier. For example, if you wanted an assembly that had a bu close to half of
             assembly bob, you'd give param='percentBu', compareTo=(bob,0.5) If you want one with a
             bu close to 0.3, you'd do param='percentBu',compareTo=0.3. Yes, if you give a (float,
-            multiplier) tuple, the code will make fun of you for not doing your own math, but will
-            still operate as expected.
+            multiplier) tuple the code will still work as expected.
 
         forceSide : bool, optional
             requires the found assembly to have either 1: higher, -1: lower, None: any param than
-             compareTo
+            compareTo
 
         exclusions : list, optional
             List of assemblies that will be excluded from the search

armi/utils/gridEditor.py

@@ -51,8 +51,7 @@
   between asemblies of different design, but the same flags.
 
 * No proper zoom support, and object sizes are fixed and don't accommodate long
-  specifiers. Adding zoom would make for a fun first task to a new developer interested
-  in computer graphics.
+  specifiers.
 """
 
 import colorsys