Fixing docstrings for camera stage mapping changes.
This commit is contained in:
parent
531e5c27b2
commit
705cf73173
2 changed files with 7 additions and 2 deletions
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue