From 73d553b54249a275a888ef4ecfe9f46232a08364 Mon Sep 17 00:00:00 2001 From: Ed Cormany Date: Wed, 6 Dec 2023 10:50:20 -0500 Subject: [PATCH] docs(api): docstring for `load_waste_chute()` (#14058) --- api/src/opentrons/protocol_api/protocol_context.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/api/src/opentrons/protocol_api/protocol_context.py b/api/src/opentrons/protocol_api/protocol_context.py index 1f81c66f27a..daef5140f6e 100644 --- a/api/src/opentrons/protocol_api/protocol_context.py +++ b/api/src/opentrons/protocol_api/protocol_context.py @@ -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."