Skip to content

Commit

Permalink
versionchanged for location params
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany committed Mar 5, 2024
1 parent 1cc1305 commit 365f7da
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions api/src/opentrons/protocol_api/instrument_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -301,8 +301,8 @@ def dispense( # noqa: C901
:type volume: int or float
:param location: Tells the robot where to dispense liquid held in the pipette.
The location can be a :py:class:`.Well` or a
:py:class:`.Location`.
The location can be a :py:class:`.Well`, :py:class:`.Location`,
:py:class:`.TrashBin`, or :py:class:`.WasteChute`.
- If the location is a ``Well``, the pipette will dispense
at or above the bottom center of the well. The distance (in
Expand All @@ -322,6 +322,9 @@ def dispense( # noqa: C901
liquid aspirated into the pipette will be dispensed (the
amount is accessible through :py:attr:`current_volume`).
.. versionchanged:: 2.16
Accepts ``TrashBin`` and ``WasteChute`` values.
:param rate: How quickly a pipette dispenses liquid. The speed in µL/s is
calculated as ``rate`` multiplied by :py:attr:`flow_rate.dispense
<flow_rate>`. If not specified, defaults to 1.0. See
Expand Down Expand Up @@ -543,6 +546,9 @@ def blow_out(
without first calling a method that takes a location, like
:py:meth:`.aspirate` or :py:meth:`dispense`.
:returns: This instance.
.. versionchanged:: 2.16
The ``location`` parameter accepts ``TrashBin`` and ``WasteChute`` values.
"""
well: Optional[labware.Well] = None
move_to_location: types.Location
Expand Down Expand Up @@ -1007,6 +1013,9 @@ def drop_tip(
position.
:returns: This instance.
.. versionchanged:: 2.16
The ``location`` parameter accepts ``TrashBin`` and ``WasteChute`` values.
"""
alternate_drop_location: bool = False
if location is None:
Expand Down Expand Up @@ -1437,6 +1446,9 @@ def move_to(
:param publish: Whether to list this function call in the run preview.
Default is ``True``.
.. versionchanged:: 2.16
The ``location`` parameter accepts ``TrashBin`` and ``WasteChute`` values.
"""
with ExitStack() as contexts:
if isinstance(location, (TrashBin, WasteChute)):
Expand Down

0 comments on commit 365f7da

Please sign in to comment.