Skip to content

Commit

Permalink
docs(api): docstring for load_trash_bin() (#14108)
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany authored Dec 7, 2023
1 parent 4931123 commit 3402168
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions api/src/opentrons/protocol_api/protocol_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,15 @@ def load_adapter_from_definition(

@requires_version(2, 16)
def load_trash_bin(self, location: DeckLocation) -> TrashBin:
"""Load a trash bin on the deck of a Flex.
If you try to load a trash bin on an OT-2, the API will raise an error.
:param location: The :ref:`deck slot <deck-slots>` where the trash bin is. The
location can be any unoccupied slot in column 1 or 3.
If you try to load a trash bin in column 2 or 4, the API will raise an error.
"""
slot_name = validation.ensure_and_convert_deck_slot(
location,
api_version=self._api_version,
Expand Down

0 comments on commit 3402168

Please sign in to comment.