Skip to content

Commit

Permalink
docs(api): docstring for load_waste_chute() (#14058)
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany authored Dec 6, 2023
1 parent 6518737 commit 73d553b
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion api/src/opentrons/protocol_api/protocol_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -463,9 +463,14 @@ def load_trash_bin(self, location: DeckLocation) -> TrashBin:
def load_waste_chute(
self,
*,
# TODO: Confirm official naming of "staging area slot".
with_staging_area_slot_d4: bool = False,
) -> WasteChute:
"""Load the waste chute on the deck.
The deck plate adapter for the waste chute can only go in slot D3. If you try to
load another item in slot D3 after loading the waste chute, or vice versa, the
API will raise an error.
"""
if with_staging_area_slot_d4:
raise NotImplementedError(
"The waste chute staging area slot is not currently implemented."
Expand Down

0 comments on commit 73d553b

Please sign in to comment.