docs(api): PD interop changes in 8.5; new params #18686
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…entrons into docs-pd-interop-8.5 setting tracking to chore_release-8.5.0 for this docs branch.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## chore_release-8.5.0 #18686 +/- ##
====================================================
Coverage 24.22% 24.22%
====================================================
Files 3258 3258
Lines 281743 281743
Branches 29429 29429
====================================================
Hits 68247 68247
Misses 213474 213474
Partials 22 22
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
ecormany
reviewed
Jun 23, 2025
| @@ -312,7 +312,7 @@ This example uses the current well and sets the speed to 80 mm/s:: | |||
| Mix | |||
| ==== | |||
|
|
|||
| The :py:meth:`~.InstrumentContext.mix` method aspirates and dispenses repeatedly in a single location. It's designed to mix the contents of a well together using a single command rather than using multiple ``aspirate()`` and ``dispense()`` calls. This method includes arguments that let you specify the number of times to mix, the volume (in µL) of liquid, and the well that contains the liquid you want to mix. | |||
| The :py:meth:`~.InstrumentContext.mix` method aspirates and dispenses repeatedly in a single location. It's designed to mix the contents of a well together using a single command rather than using multiple ``aspirate()`` and ``dispense()`` calls. This method includes arguments that let you specify the number of times to mix, the volume (in µL) of liquid, and the well that contains the liquid you want to mix. | |||
There was a problem hiding this comment.
Spurious change, and better to not have trailing whitespace.
Comment on lines
+573
to
+575
| :param aspirate_flow_rate: The absolute flow rate for each aspirate in the mix, in µL/s. | ||
| If this is specified, ``rate`` must not be set. | ||
| :param dispense_flow_rate: The flow rate for each dispense in the mix, in µL/s. | ||
| :param dispense_flow_rate: The absolute flow rate for each dispense in the mix, in µL/s. |
There was a problem hiding this comment.
Not strictly needed, "in µL/s" is clear enough.
There was a problem hiding this comment.
I think I changed this only to match the aspirate() and dispense() entries; I checked those first.
…entrons into docs-pd-interop-8.5 getting latest
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Updates to the Liquid Control page for PD interop + new params added.
Test Plan and Hands on Testing
sandbox: http://sandbox.docs.opentrons.com/docs-pd-interop-8.5/v2/
Changelog
-added description for
flow_rateparam in aspirate/dispense commands (and contrast withrate). checked the API reference entries.in_placeandflow_rateparameters (and contrast withrate)mm_from_edgebehavior and warning.Review requests
Need to confirm the warning for
mm_from_edgein touch tip.Risk assessment
low.