Skip to content

Commit 73d553b

Browse files
authored
docs(api): docstring for load_waste_chute() (#14058)
1 parent 6518737 commit 73d553b

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

api/src/opentrons/protocol_api/protocol_context.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -463,9 +463,14 @@ def load_trash_bin(self, location: DeckLocation) -> TrashBin:
463463
def load_waste_chute(
464464
self,
465465
*,
466-
# TODO: Confirm official naming of "staging area slot".
467466
with_staging_area_slot_d4: bool = False,
468467
) -> WasteChute:
468+
"""Load the waste chute on the deck.
469+
470+
The deck plate adapter for the waste chute can only go in slot D3. If you try to
471+
load another item in slot D3 after loading the waste chute, or vice versa, the
472+
API will raise an error.
473+
"""
469474
if with_staging_area_slot_d4:
470475
raise NotImplementedError(
471476
"The waste chute staging area slot is not currently implemented."

0 commit comments

Comments
 (0)