Skip to content

Commit

Permalink
move versionchanged from methods to params
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany committed Mar 7, 2024
1 parent f8980c0 commit e15a920
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions api/src/opentrons/protocol_api/instrument_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -546,17 +546,18 @@ def blow_out(
:ref:`blow-out`.
:param location: The blowout location. If no location is specified, the pipette
will blow out from its current position.
will blow out from its current position.
.. versionchanged:: 2.18
Accepts ``TrashBin`` and ``WasteChute`` values.
:type location: :py:class:`.Well` or :py:class:`.Location` or ``None``
:raises RuntimeError: If no location is specified and the location cache is
``None``. This should happen if ``blow_out()`` is called
without first calling a method that takes a location, like
:py:meth:`.aspirate` or :py:meth:`dispense`.
:returns: This instance.
.. versionchanged:: 2.18
The ``location`` parameter accepts ``TrashBin`` and ``WasteChute`` values.
"""
well: Optional[labware.Well] = None
move_to_location: types.Location
Expand Down Expand Up @@ -1009,7 +1010,11 @@ def drop_tip(
``pipette.drop_tip(location=waste_chute)``.
:param location:
The location to drop the tip.
Where to drop the tip.
.. versionchanged:: 2.16
Accepts ``TrashBin`` and ``WasteChute`` values.
:type location:
:py:class:`~.types.Location` or :py:class:`.Well` or ``None``
:param home_after:
Expand All @@ -1021,9 +1026,6 @@ def drop_tip(
position.
:returns: This instance.
.. versionchanged:: 2.18
The ``location`` parameter accepts ``TrashBin`` and ``WasteChute`` values.
"""
alternate_drop_location: bool = False
if location is None:
Expand Down Expand Up @@ -1436,7 +1438,11 @@ def move_to(
See :ref:`move-to` for examples.
:param location: The location to move to.
:param location: Where to move to.
.. versionchanged:: 2.18
Accepts ``TrashBin`` and ``WasteChute`` values.
:type location: :py:class:`~.types.Location`
:param force_direct: If ``True``, move directly to the destination without arc
motion.
Expand All @@ -1454,9 +1460,6 @@ def move_to(
:param publish: Whether to list this function call in the run preview.
Default is ``True``.
.. versionchanged:: 2.18
The ``location`` parameter accepts ``TrashBin`` and ``WasteChute`` values.
"""
with ExitStack() as contexts:
if isinstance(location, (TrashBin, WasteChute)):
Expand Down

0 comments on commit e15a920

Please sign in to comment.