Skip to content

Commit 3daa34a

Browse files
authored
docs(api): note on set_offset() for multiple of same labware in 2.12-13 (#17796)
# Overview Quick addition to the API reference to caution users away from an edge case with `set_offset()` and LPC. Addresses RTC-714. ## Test Plan and Hands on Testing [Sandbox](http://sandbox.docs.opentrons.com/docs-set_offset-note/v2/new_protocol_api.html#opentrons.protocol_api.Labware.set_offset) ## Changelog Added a sentence to the existing table in the `set_offset()` API reference entry. ## Review requests Good advice? ## Risk assessment none
1 parent 659ec40 commit 3daa34a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

api/src/opentrons/protocol_api/labware.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -762,11 +762,15 @@ def set_offset(self, x: float, y: float, z: float) -> None:
762762
763763
.. list-table::
764764
:header-rows: 1
765+
:widths: 1 5
765766
766767
* - API level
767768
- Offset behavior
768769
* - 2.12–2.13
769770
- Offsets only apply to the exact :py:class:`.Labware` instance.
771+
772+
If your protocol has multiple instances of the same type of labware,
773+
you must either use ``set_offset()`` on all of them or none of them.
770774
* - 2.14–2.17
771775
- ``set_offset()`` is not available, and the API raises an error.
772776
* - 2.18 and newer

0 commit comments

Comments
 (0)