Skip to content

Commit

Permalink
docstring and versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany committed Aug 6, 2024
1 parent 7486087 commit 1eadc93
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
9 changes: 8 additions & 1 deletion api/docs/v2/versioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The maximum supported API version for your robot is listed in the Opentrons App

If you upload a protocol that specifies a higher API level than the maximum supported, your robot won't be able to analyze or run your protocol. You can increase the maximum supported version by updating your robot software and Opentrons App.

Opentrons robots running the latest software (7.3.0) support the following version ranges:
Opentrons robots running the latest software (8.0.0) support the following version ranges:

* **Flex:** version 2.15–|apiLevel|.
* **OT-2:** versions 2.0–|apiLevel|.
Expand All @@ -84,6 +84,8 @@ This table lists the correspondence between Protocol API versions and robot soft
+-------------+------------------------------+
| API Version | Introduced in Robot Software |
+=============+==============================+
| 2.20 | 8.0.0 |
+-------------+------------------------------+
| 2.19 | 7.3.1 |
+-------------+------------------------------+
| 2.18 | 7.3.0 |
Expand Down Expand Up @@ -132,6 +134,11 @@ This table lists the correspondence between Protocol API versions and robot soft
Changes in API Versions
=======================

Version 2.20
------------

- :py:meth:`.configure_nozzle_layout` now accepts row, single, and partial column layout constants. See :ref:`partial-tip-pickup`.

Version 2.19
------------

Expand Down
15 changes: 7 additions & 8 deletions api/src/opentrons/protocol_api/instrument_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -2013,15 +2013,15 @@ def configure_nozzle_layout( # noqa: C901
:param style: The shape of the nozzle layout.
- ``SINGLE`` sets the pipette to use 1 nozzle. This corresponds to a single of well on labware.
- ``ALL`` resets the pipette to use all of its nozzles. Calling
``configure_nozzle_layout`` with no arguments also resets the pipette.
- ``COLUMN`` sets the pipette to use 8 nozzles, aligned from front to back
with respect to the deck. This corresponds to a column of wells on labware.
- ``PARTIAL_COLUMN`` sets the pipette to use 2-7 nozzles, aligned from front to back
- ``PARTIAL_COLUMN`` sets the pipette to use 2--7 nozzles, aligned from front to back
with respect to the deck.
- ``ROW`` sets the pipette to use 12 nozzles, aligned from left to right
with respect to the deck. This corresponds to a row of wells on labware.
- ``ALL`` resets the pipette to use all of its nozzles. Calling
``configure_nozzle_layout`` with no arguments also resets the pipette.
- ``SINGLE`` sets the pipette to use 1 nozzle. This corresponds to a single of well on labware.
:type style: ``NozzleLayout`` or ``None``
:param start: The primary nozzle of the layout, which the robot uses
Expand All @@ -2039,16 +2039,15 @@ def configure_nozzle_layout( # noqa: C901
should be of the same format used when identifying wells by name.
Required when setting ``style=PARTIAL_COLUMN``.
.. note::
Nozzle layouts numbering between 2-7 nozzles, account for the distance from
``start``. For example, 4 nozzles would require ``start="H1"`` and ``end="E1"``.
:type end: str or ``None``
:param tip_racks: Behaves the same as setting the ``tip_racks`` parameter of
:py:meth:`.load_instrument`. If not specified, the new configuration resets
:py:obj:`.InstrumentContext.tip_racks` and you must specify the location
every time you call :py:meth:`~.InstrumentContext.pick_up_tip`.
:type tip_racks: List[:py:class:`.Labware`]
.. versionchanged:: 2.20
Added partial column, row, and single layouts.
"""
# TODO: add the following back into the docstring when QUADRANT is supported
#
Expand Down

0 comments on commit 1eadc93

Please sign in to comment.