Skip to content

Commit

Permalink
clearer docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sanni-t committed Aug 24, 2023
1 parent b684185 commit 2aeedfe
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions api/src/opentrons/protocol_engine/state/geometry.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 2aeedfe

Please sign in to comment.