Merge pull request #336 from lsst/tickets/DM-4037

DM-4037: Require non-empty doc string for config parameters
lsst · Jun 9, 2023 · 2d6725e · 2d6725e
2 parents b6be565 + aa64232
commit 2d6725e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/tests/test_configOverrides.py b/tests/test_configOverrides.py
@@ -33,19 +33,19 @@
 
 
 class ConfigTest(pexConfig.Config):
-    fStr = pexConfig.Field(dtype=str, default="default", doc="")
-    fBool = pexConfig.Field(dtype=bool, default=False, doc="")
-    fInt = pexConfig.Field(dtype=int, default=-1, doc="")
-    fFloat = pexConfig.Field(dtype=float, default=-1.0, doc="")
+    fStr = pexConfig.Field(dtype=str, default="default", doc="test")
+    fBool = pexConfig.Field(dtype=bool, default=False, doc="test")
+    fInt = pexConfig.Field(dtype=int, default=-1, doc="test")
+    fFloat = pexConfig.Field(dtype=float, default=-1.0, doc="test")
 
-    fListStr = pexConfig.ListField(dtype=str, default=[], doc="")
-    fListBool = pexConfig.ListField(dtype=bool, default=[], doc="")
-    fListInt = pexConfig.ListField(dtype=int, default=[], doc="")
+    fListStr = pexConfig.ListField(dtype=str, default=[], doc="test")
+    fListBool = pexConfig.ListField(dtype=bool, default=[], doc="test")
+    fListInt = pexConfig.ListField(dtype=int, default=[], doc="test")
 
-    fChoiceStr = pexConfig.ChoiceField(dtype=str, allowed=dict(A="a", B="b", C="c"), doc="")
-    fChoiceInt = pexConfig.ChoiceField(dtype=int, allowed={1: "a", 2: "b", 3: "c"}, doc="")
+    fChoiceStr = pexConfig.ChoiceField(dtype=str, allowed=dict(A="a", B="b", C="c"), doc="test")
+    fChoiceInt = pexConfig.ChoiceField(dtype=int, allowed={1: "a", 2: "b", 3: "c"}, doc="test")
 
-    fDictStrInt = pexConfig.DictField(keytype=str, itemtype=int, doc="")
+    fDictStrInt = pexConfig.DictField(keytype=str, itemtype=int, doc="test")
 
 
 class ConfigOverridesTestCase(unittest.TestCase):

diff --git a/tests/test_testUtils.py b/tests/test_testUtils.py
@@ -136,11 +136,11 @@ class SkyPixConnections(PipelineTaskConnections, dimensions={"skypix"}):
 
 
 class VisitConfig(PipelineTaskConfig, pipelineConnections=VisitConnections):
-    doUseInitIn = lsst.pex.config.Field(default=False, dtype=bool, doc="")
+    doUseInitIn = lsst.pex.config.Field(default=False, dtype=bool, doc="test")
 
 
 class PatchConfig(PipelineTaskConfig, pipelineConnections=PatchConnections):
-    doUseB = lsst.pex.config.Field(default=True, dtype=bool, doc="")
+    doUseB = lsst.pex.config.Field(default=True, dtype=bool, doc="test")
 
 
 class SkyPixConfig(PipelineTaskConfig, pipelineConnections=SkyPixConnections):