Skip to content

Commit 9126382

Browse files
docs(api): final 2.23 updates (#18325)
<!-- Thanks for taking the time to open a Pull Request (PR)! Please make sure you've read the "Opening Pull Requests" section of our Contributing Guide: https://github.com/Opentrons/opentrons/blob/edge/CONTRIBUTING.md#opening-pull-requests GitHub provides robust markdown to format your PR. Links, diagrams, pictures, and videos along with text formatting make it possible to create a rich and informative PR. For more information on GitHub markdown, see: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax To ensure your code is reviewed quickly and thoroughly, please fill out the sections below to the best of your ability! --> # Overview Making final* changes to API 2.23 documentation. So far: - small fix for clarity in describing the meniscus position - meniscus code blocks follow the new arg order in [https://github.com/Opentrons/opentrons/pull/18086](url) - making a small edit to the `resin_tip_dispense()` rate parameter description ([ticketed](https://opentrons.atlassian.net/browse/EXEC-1489) by David) -changes to release notes: syntax, etc. TODO: any additional release notes items + format for JS. hide any remaining 2.24 features. <!-- Describe your PR at a high level. State acceptance criteria and how this PR fits into other work. Link issues, PRs, and other relevant resources. --> ## Test Plan and Hands on Testing <!-- Describe your testing of the PR. Emphasize testing not reflected in the code. Attach protocols, logs, screenshots and any other assets that support your testing. --> ## Changelog <!-- List changes introduced by this PR considering future developers and the end user. Give careful thought and clear documentation to breaking changes. --> Will continue making changes as needed this week. ## Review requests <!-- - What do you need from reviewers to feel confident this PR is ready to merge? - Ask questions. --> ## Risk assessment <!-- - Indicate the level of attention this PR needs. - Provide context to guide reviewers. - Discuss trade-offs, coupling, and side effects. - Look for the possibility, even if you think it's small, that your change may affect some other part of the system. - For instance, changing return tip behavior may also change the behavior of labware calibration. - How do your unit tests and on hands on testing mitigate this PR's risks and the risk of future regressions? - Especially in high risk PRs, explain how you know your testing is enough. --> low. --------- Co-authored-by: Edward Cormany <[email protected]>
1 parent 917a7cf commit 9126382

File tree

4 files changed

+8
-14
lines changed

4 files changed

+8
-14
lines changed

api/docs/v2/basic_commands/liquids.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ This example measures the liquid height in well A2 of a plate and then immediate
6060
pipette.measure_liquid_height(plate["A2"])
6161
pipette.aspirate(
6262
volume=200,
63-
location=plate["A2"].meniscus(target="end", z=-1)
63+
location=plate["A2"].meniscus(z=-1, target="end")
6464
)
6565
# aspirates at 1 mm below the liquid meniscus
6666

@@ -138,7 +138,7 @@ This example measures the liquid height in well B1 of a plate and then immediate
138138
pipette.measure_liquid_height(plate["B1"])
139139
pipette.dispense(
140140
volume=200,
141-
location=plate["B1"].meniscus(target="start", z=-1)
141+
location=plate["B1"].meniscus(z=-1, target="start")
142142
)
143143
# dispenses at 1 mm below the liquid meniscus
144144

@@ -381,7 +381,7 @@ The :py:meth:`~.InstrumentContext.measure_liquid_height` method tells a Flex pip
381381
pipette.pick_up_tip()
382382
pipette.measure_liquid_height(plate["A1"])
383383
pipette.aspirate(
384-
volume=200, location=plate["A1"].meniscus(target="end", z=-1)
384+
volume=200, location=plate["A1"].meniscus(z=-1, target="end")
385385
) # aspirates from 1 mm below the liquid meniscus
386386
387387
You don't have to aspirate after measuring liquid height, but you should always pick up a tip immediately prior to measuring the liquid height, and either aspirate or drop the tip immediately after. This ensures that the pipette uses a clean, dry tip to check for liquid, and prevents cross-contamination.

api/docs/v2/robot_position.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,12 @@ Let's look at the :py:meth:`.Well.center` method. It returns a position centered
8686
Meniscus
8787
^^^^^^^^
8888

89-
Let's look at the :py:meth:`.Well.meniscus` method. It returns a position at the surface of liquid, or meniscus, inside a well. Like the ``.Well.top`` and ``.Well.bottom`` methods, you can adjust the height of the meniscus with the optional argument ``z``, which is measured in mm. Positive ``z`` values move the position up, and negative ones move it down.
89+
Let's look at the :py:meth:`.Well.meniscus` method. It returns a position at the surface of liquid, or meniscus, inside a well. Similar to the ``.Well.top`` and ``.Well.bottom`` methods, you can adjust the height of this position with the optional argument ``z``, which is measured in mm. Positive ``z`` values move the position up, and negative ones move it down.
9090

9191
.. code-block:: python
9292
9393
plate["A1"].meniscus(
94-
target= "end", z=-1
94+
z=-1, target= "end"
9595
)
9696
# 1 mm below the meniscus of liquid inside the well
9797

api/release-notes.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,12 @@ Welcome to the v8.4.0 release of the Opentrons robot software! This release incl
1919

2020
### Improvements
2121

22-
- Improved tip drop motions for Flex 1- and 8-channel pipettes correctly drop and return attached tips to the tip rack.
22+
- Improved tip drop motions for Flex 1-channel and 8-channel pipettes correctly drop and return attached tips to the tip rack.
2323

2424
### Bug Fixes
2525

2626
- The API raises an error if the Absorbance Plate Reader fails to initialize before reading a plate inside the module.
2727

28-
### Known Issues
29-
30-
- When you use `load_liquid()` and then use `measure_liquid_height()` on the same well, protocol analysis won't raise an error if there's not enough liquid to complete your transfers. To avoid errors during an actual run, use only one of the two commands.
31-
3228
## Opentrons Robot Software Changes in 8.3.1
3329

3430
The 8.3.1 hotfix release contains two bug fixes:

api/src/opentrons/protocol_api/instrument_context.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2085,12 +2085,10 @@ def resin_tip_dispense(
20852085
to the volume of liquid that will be dispensed.
20862086
:type volume: float
20872087
2088-
:param rate: How quickly the plunger moves to displace the commanded volume. The plunger speed
2089-
in µL/s is calculated as ``rate`` multiplied by
2090-
:py:attr:`flow_rate.dispense<flow_rate>`. This rate does not directly relate to
2088+
:param rate: How quickly the plunger moves to displace the commanded volume, in µL/s. This rate does not directly relate to
20912089
the flow rate of liquid out of the resin tip.
20922090
2093-
The default value of ``10.0`` is recommended.
2091+
Defaults to ``10.0`` µL/s.
20942092
:type rate: float
20952093
"""
20962094
well: Optional[labware.Well] = None

0 commit comments

Comments
 (0)