diff --git a/api/docs/v2/deck_slots.rst b/api/docs/v2/deck_slots.rst index 31d934a1255f..2c38e70755fc 100644 --- a/api/docs/v2/deck_slots.rst +++ b/api/docs/v2/deck_slots.rst @@ -150,7 +150,7 @@ Starting in API version 2.16, you must load trash bin fixtures in your protocol .. versionadded:: 2.16 .. note:: - The ``TrashBin`` class doesn't have any callable methods, so you don't have to save the result of ``load_trash_bin()`` to a variable, especially if your protocol only loads a single trash container. Being able to reference the trash bin by name is useful when dealing with multiple trash containers. + The :py:class:`.TrashBin` class doesn't have any callable methods, so you don't have to save the result of ``load_trash_bin()`` to a variable, especially if your protocol only loads a single trash container. Being able to reference the trash bin by name is useful when dealing with multiple trash containers. Call ``load_trash_bin()`` multiple times to add more than one bin. See :ref:`pipette-trash-containers` for more information on using pipettes with multiple trash bins. diff --git a/api/docs/v2/moving_labware.rst b/api/docs/v2/moving_labware.rst index ee405f5c2525..0d0fbc3385f9 100644 --- a/api/docs/v2/moving_labware.rst +++ b/api/docs/v2/moving_labware.rst @@ -132,7 +132,7 @@ If the labware is inaccessible, the API will raise an error. Movement into the Waste Chute ============================= -Move used tip racks and well plates to the waste chute to dispose of them. This requires you to first :ref:`configure the waste chute ` in your protocol. Then use the loaded ``WasteChute`` object as the value of ``new_location``:: +Move used tip racks and well plates to the waste chute to dispose of them. This requires you to first :ref:`configure the waste chute ` in your protocol. Then use the loaded :py:class:`.WasteChute` object as the value of ``new_location``:: chute = protocol.load_waste_chute() protocol.move_labware( diff --git a/api/docs/v2/versioning.rst b/api/docs/v2/versioning.rst index d93f51212cee..2fabc14908c0 100644 --- a/api/docs/v2/versioning.rst +++ b/api/docs/v2/versioning.rst @@ -148,7 +148,7 @@ This version introduces new features for Flex and adds and improves methods for - Other changes - - :py:obj:`.ProtocolContext.fixed_trash` and :py:obj:`.InstrumentContext.trash_container` now return ``TrashBin`` objects instead of :py:class:`.Labware` objects. + - :py:obj:`.ProtocolContext.fixed_trash` and :py:obj:`.InstrumentContext.trash_container` now return :py:class:`.TrashBin` objects instead of :py:class:`.Labware` objects. - Flex will no longer automatically drop tips in the trash at the end of a protocol. You can add a :py:meth:`.drop_tip()` command to your protocol or use the Opentrons App to drop the tips. - Known issues diff --git a/api/src/opentrons/protocol_api/instrument_context.py b/api/src/opentrons/protocol_api/instrument_context.py index 7c039efc6d09..8712367671e3 100644 --- a/api/src/opentrons/protocol_api/instrument_context.py +++ b/api/src/opentrons/protocol_api/instrument_context.py @@ -979,10 +979,10 @@ def drop_tip( - As a :py:class:`~.types.Location`. For example, to drop a tip from an unusually large height above the tip rack, you could call ``pipette.drop_tip(tip_rack["A1"].top(z=10))``. - - As a ``TrashBin``. This uses a default location relative to the + - As a :py:class:`.TrashBin`. This uses a default location relative to the ``TrashBin`` object. For example, ``pipette.drop_tip(location=trash_bin)``. - - As a ``WasteChute``. This uses a default location relative to + - As a :py:class:`.WasteChute`. This uses a default location relative to the ``WasteChute`` object. For example, ``pipette.drop_tip(location=waste_chute)``. @@ -1543,7 +1543,7 @@ def trash_container(self) -> Union[labware.Labware, TrashBin, WasteChute]: This is the property used to determine where to drop tips and blow out liquids when calling :py:meth:`drop_tip` or :py:meth:`blow_out` without arguments. - You can set this to a :py:obj:`Labware`, ``TrashBin``, or ``WasteChute``. + You can set this to a :py:obj:`Labware`, :py:class:`.TrashBin`, or :py:class:`.WasteChute`. The default value depends on the robot type and API version: diff --git a/api/src/opentrons/protocol_api/protocol_context.py b/api/src/opentrons/protocol_api/protocol_context.py index d6b9d541600d..76ae81ad38e9 100644 --- a/api/src/opentrons/protocol_api/protocol_context.py +++ b/api/src/opentrons/protocol_api/protocol_context.py @@ -1061,7 +1061,7 @@ def fixed_trash(self) -> Union[Labware, TrashBin]: In API version 2.15 only, Flex protocols have a fixed trash in slot A3. - In API version 2.16 and later, the fixed trash only exists in OT-2 protocols. It is a ``TrashBin`` object, which doesn't have any wells. Trying to access ``fixed_trash`` in a Flex protocol will raise an error. See :ref:`configure-trash-bin` for details on using the movable trash in Flex protocols. + In API version 2.16 and later, the fixed trash only exists in OT-2 protocols. It is a :py:class:`.TrashBin` object, which doesn't have any wells. Trying to access ``fixed_trash`` in a Flex protocol will raise an error. See :ref:`configure-trash-bin` for details on using the movable trash in Flex protocols. .. versionchanged:: 2.16 Returns a ``TrashBin`` object.