Fix docstring formatting
This commit is contained in:
parent
dacf219ea1
commit
4eca6c3f54
1 changed files with 5 additions and 5 deletions
|
|
@ -49,9 +49,9 @@ class BaseStage(lt.Thing):
|
||||||
"""Initialise the stage.
|
"""Initialise the stage.
|
||||||
|
|
||||||
:raises RedefinedBaseMovementError: if ``move_relative`` and/or
|
:raises RedefinedBaseMovementError: if ``move_relative`` and/or
|
||||||
``move_absolute`` are overridden. It is recommended to override
|
``move_absolute`` are overridden. It is recommended to override
|
||||||
``_hardware_move_relative`` and/or ``_hardware_move_absolute`` instead so that
|
``_hardware_move_relative`` and/or ``_hardware_move_absolute`` instead so
|
||||||
all code in the child class uses the hardware reference frame.
|
that all code in the child class uses the hardware reference frame.
|
||||||
"""
|
"""
|
||||||
self._hardware_position = dict.fromkeys(self._axis_names, 0)
|
self._hardware_position = dict.fromkeys(self._axis_names, 0)
|
||||||
|
|
||||||
|
|
@ -155,7 +155,7 @@ class BaseStage(lt.Thing):
|
||||||
):
|
):
|
||||||
"""Make a relative move in the coordinate system used by the physical hardware.
|
"""Make a relative move in the coordinate system used by the physical hardware.
|
||||||
|
|
||||||
Make sure to use and update `self._hardware_position` not `self.position`.
|
Make sure to use and update ``self._hardware_position`` not ``self.position``.
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError(
|
raise NotImplementedError(
|
||||||
"StageThings must define their own _hardware_move_relative method"
|
"StageThings must define their own _hardware_move_relative method"
|
||||||
|
|
@ -183,7 +183,7 @@ class BaseStage(lt.Thing):
|
||||||
):
|
):
|
||||||
"""Make a absolute move in the coordinate system used by the physical hardware.
|
"""Make a absolute move in the coordinate system used by the physical hardware.
|
||||||
|
|
||||||
Make sure to use and update `self._hardware_position` not `self.position`.
|
Make sure to use and update ``self._hardware_position`` not ``self.position``.
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError(
|
raise NotImplementedError(
|
||||||
"StageThings must define their own move_absolute method"
|
"StageThings must define their own move_absolute method"
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue