From 705cf73173b6df274ddc0b33913cd4baee950d43 Mon Sep 17 00:00:00 2001 From: Julian Stirling Date: Sun, 13 Jul 2025 23:53:44 +0100 Subject: [PATCH] Fixing docstrings for camera stage mapping changes. --- .../things/camera_stage_mapping.py | 5 +++-- src/openflexure_microscope_server/things/stage/__init__.py | 4 ++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/src/openflexure_microscope_server/things/camera_stage_mapping.py b/src/openflexure_microscope_server/things/camera_stage_mapping.py index 5a8e3b7e..da363ccc 100644 --- a/src/openflexure_microscope_server/things/camera_stage_mapping.py +++ b/src/openflexure_microscope_server/things/camera_stage_mapping.py @@ -62,9 +62,10 @@ class RecordedMove: """ def __init__(self, stage: Stage): - """Set the movement function to be wrapped. + """Set the stage client used for for movement. - :param move_function: the movement function to be wrapped + :param stage: the stage client to be used. ``stage.move_to_xyz_position`` will + be called whenever the instance is called. """ self._stage: Stage = stage self._current_position: Optional[CoordinateType] = None diff --git a/src/openflexure_microscope_server/things/stage/__init__.py b/src/openflexure_microscope_server/things/stage/__init__.py index ac9a9b2b..197a548e 100644 --- a/src/openflexure_microscope_server/things/stage/__init__.py +++ b/src/openflexure_microscope_server/things/stage/__init__.py @@ -105,6 +105,10 @@ class BaseStage(lt.Thing): ) -> None: """Move to the location specified by an (x, y, z) tuple. + :param cancel: A cancel hook for cancelling the move. This dependency should be + injected automatically by LabThings-FastAPI + :param xyz_pos: The (x, y, z) position to move to. + :raises KeyError: if this stage does not have axes named "x", "y", and "z". This method is provides the interface expected by the camera_stage_mapping.