From 2aeedfe9f0605ac4d75ecf1c06c56a573e117aad Mon Sep 17 00:00:00 2001 From: Sanniti Date: Thu, 24 Aug 2023 17:45:44 -0400 Subject: [PATCH] clearer docs --- api/src/opentrons/protocol_engine/state/geometry.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/api/src/opentrons/protocol_engine/state/geometry.py b/api/src/opentrons/protocol_engine/state/geometry.py index 47fa4dd27bc..cabe52ce258 100644 --- a/api/src/opentrons/protocol_engine/state/geometry.py +++ b/api/src/opentrons/protocol_engine/state/geometry.py @@ -139,6 +139,15 @@ def _get_labware_position_offset( """Gets the offset vector of a labware on the given location. NOTE: Not to be confused with LPC offset. + - For labware on Deck Slot: returns an offset of (0, 0, 0) + - For labware on a Module: returns the nominal offset for the labware's position + when placed on the specified module (using slot-transformed labwareOffset + from the module's definition with any stacking overlap). + Does not include module calibration offset or LPC offset. + - For labware on another labware: returns the nominal offset for the labware + as placed on the specified labware, taking into account any offsets for labware + on modules as well as stacking overlaps. + Does not include module calibration offset or LPC offset. """ if isinstance(labware_location, DeckSlotLocation): return LabwareOffsetVector(x=0, y=0, z=0)