Class docstrings

tests/mock_things/mock_autofocus.py

@@ -9,6 +9,13 @@ answers to functions.
 
 
 class MockAutoFocusThing:
+    """A mock autofocus Thing that imports no code from AutofocusThing.
+
+    The class needs functionality added to it over time as more complex
+    mocking is needed. It imports no code from AutofocusThing so that coverage
+    is not artificially inflated.
+    """
+
     # Counter for checking functions were called
     mock_call_count = {"looping_autofocus": 0}
 

tests/mock_things/mock_background_detect.py

@@ -10,7 +10,14 @@ answers to functions.
 from openflexure_microscope_server.things.background_detect import ChannelDistributions
 
 
-class MockBackgoundDetectThing:
+class MockBackgroundDetectThing:
+    """A mock background detect Thing that imports no code from BackgroundDetectThing.
+
+    The class needs functionality added to it over time as more complex
+    mocking is needed. It imports no code from BackgroundDetectThing so that coverage
+    is not artificially inflated.
+    """
+
     background_distributions = ChannelDistributions(
         means=[128.0, 128.0, 128.0],
         standard_deviations=[3.0, 3.0, 3.0],

tests/mock_things/mock_csm.py

@@ -9,4 +9,11 @@ answers to functions.
 
 
 class MockCSMThing:
+    """A mock CSM Thing that imports no code from CameraStageMapper.
+
+    The class needs functionality added to it over time as more complex
+    mocking is needed. It imports no code from CameraStageMapper so that coverage
+    is not artificially inflated.
+    """
+
     image_resolution = (123, 456)

tests/mock_things/mock_stage.py

@@ -9,4 +9,11 @@ answers to functions.
 
 
 class MockStageThing:
+    """A mock Thing for a stage that imports no code from BaseStage.
+
+    The class needs functionality added to it over time as more complex
+    mocking is needed. It imports no code from BaseStage so that coverage
+    is not artificially inflated.
+    """
+
     position = (111, 222, 333)

tests/test_smart_scan.py

@@ -30,7 +30,7 @@ from openflexure_microscope_server.things.smart_scan import (
 from .mock_things.mock_csm import MockCSMThing
 from .mock_things.mock_autofocus import MockAutoFocusThing
 from .mock_things.mock_stage import MockStageThing
-from .mock_things.mock_background_detect import MockBackgoundDetectThing
+from .mock_things.mock_background_detect import MockBackgroundDetectThing
 
 # A global logger to pass in as an Invocation Logger
 LOGGER = logging.getLogger("mock-invocation_logger")
@@ -172,7 +172,7 @@ def _run_only_outer_scan(adjust_inital_state: Optional[Callable] = None):
     cam_mock = 4  # not called
     meta_mock = 5  # not called
     csm_mock = MockCSMThing()
-    bkgrnd_det_mock = MockBackgoundDetectThing()
+    bkgrnd_det_mock = MockBackgroundDetectThing()
 
     class MockedSmartScanThing(SmartScanThing):
         """Mocked version of SmartScanThing with a patched _run_scan method."""