Skip to content

Commit

Permalink
in depth comments
Browse files Browse the repository at this point in the history
  • Loading branch information
jbleon95 committed Dec 8, 2023
1 parent 98173bd commit d0c16c7
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions api/src/opentrons/protocol_engine/state/addressable_areas.py
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,16 @@ def get_addressable_area_base_slot(
return addressable_area.base_slot

def get_addressable_area_position(self, addressable_area_name: str) -> Point:
"""Get the position of an addressable area."""
"""Get the position of an addressable area.
This does not require the addressable area to be in the deck configuration.
This is primarily used to support legacy fixed trash labware without
modifying the deck layout to remove the similar, but functionally different,
trashBinAdapter cutout fixture.
Besides that instance, for movement purposes, this should only be called for
areas that have been pre-validated, otherwise there could be the risk of collision.
"""
addressable_area = self._get_addressable_area_from_deck_data(
addressable_area_name
)
Expand Down Expand Up @@ -455,7 +464,10 @@ def get_fixture_height(self, cutout_fixture_name: str) -> float:
return cutout_fixture["height"]

def get_slot_definition(self, slot_id: str) -> SlotDefV3:
"""Get the definition of a slot in the deck."""
"""Get the definition of a slot in the deck.
This does not require that the slot exist in deck configuration.
"""
try:
addressable_area = self._get_addressable_area_from_deck_data(slot_id)
except AddressableAreaDoesNotExistError:
Expand Down

0 comments on commit d0c16c7

Please sign in to comment.