diff --git a/src/openflexure_microscope_server/things/stage/__init__.py b/src/openflexure_microscope_server/things/stage/__init__.py index a80d0d79..3298e2ac 100644 --- a/src/openflexure_microscope_server/things/stage/__init__.py +++ b/src/openflexure_microscope_server/things/stage/__init__.py @@ -36,6 +36,10 @@ class RedefinedBaseMovementError(RuntimeError): class BacklashCompensation(enum.Enum): """The axes to apply backlash compensation to. + This will perform a correction step - if necessary - on every + chosen axis, even if that axis position isn't set to move in + the calling movement + * MOVEMENT_AXES - Only the axes that are moving. * ALL_AXES - All axes * XY_ONLY - Only the x and y axes. diff --git a/tests/unit_tests/test_stage.py b/tests/unit_tests/test_stage.py index ccd22c17..f922ef65 100644 --- a/tests/unit_tests/test_stage.py +++ b/tests/unit_tests/test_stage.py @@ -554,7 +554,7 @@ def test_backlash_compensated_moves(test_case, dummy_stage, mocker): dummy_stage._hardware_position = dummy_stage._apply_axis_direction( test_case.position ) - # double check position is set + # check position is set assert dummy_stage.position == test_case.position dummy_stage._backlash_state = test_case.backlash_state diff --git a/tests/unit_tests/test_stage_measure.py b/tests/unit_tests/test_stage_measure.py index cbb91ed2..d4b5c5a8 100644 --- a/tests/unit_tests/test_stage_measure.py +++ b/tests/unit_tests/test_stage_measure.py @@ -487,7 +487,7 @@ def test_move_until_edge_error(rom_thing, mocker): # Error should be raised even though it is in the Try: with pytest.raises(RuntimeError, match="Mock"): rom_thing._move_until_edge("y", direction=-1) - # However the "finally" should have executed returning to the starting position + # However the "finally" should have executed, returning to the starting position assert rom_thing._stage.move_absolute.call_count == 1 abs_move_kwargs = rom_thing._stage.move_absolute.call_args.kwargs expected_abs_move_kwargs = dict(