Add docs for ParameterCollectionWhere tests

armi/reactor/tests/test_parameters.py

@@ -514,6 +514,8 @@ class MockPCChild(MockPC):
 
 
 class ParamCollectionWhere(unittest.TestCase):
+ """Tests for ParameterCollection.where."""
+
  class ScopeParamCollection(parameters.ParameterCollection):
  pDefs = parameters.ParameterDefinitionCollection()
  with pDefs.createBuilder() as pb:
@@ -556,6 +558,7 @@ def setUpClass(cls) -> None:
  cls.pc = cls.ScopeParamCollection()
 
  def test_onCategory(self):
+ """Test the use of Parameter.hasCategory on filtering."""
  names = {"keff", "cornerFlux"}
  for p in self.pc.where(
  lambda pd: pd.hasCategory(parameters.Category.neutronics)
@@ -565,6 +568,7 @@ def test_onCategory(self):
  self.assertFalse(names, msg=f"{names=} should be empty!")
 
  def test_onLocation(self):
+ """Test the use of Parameter.atLocation in filtering."""
  names = {
  "edgeTemperature",
  }
@@ -576,6 +580,7 @@ def test_onLocation(self):
  self.assertFalse(names, msg=f"{names=} should be empty!")
 
  def test_complicated(self):
+ """Test a multi-condition filter."""
  names = {
  "cornerFlux",
  }