final docs callouts #18843
Merged
final docs callouts #18843
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
caila-marashaj
approved these changes
Jul 7, 2025
ecormany
reviewed
Jul 8, 2025
api/docs/v2/liquid_classes.rst
Outdated
| @@ -128,6 +128,8 @@ Using Liquid Classes | |||
|
|
|||
| You'll use a :ref:`liquid class definition <liquid-class-definitions>` in your protocol to optimize transfer behavior based on liquid properties, along with your chosen Flex pipettes and tips. | |||
|
|
|||
| This section covers selecting a liquid class and using the :py:meth:`.InstrumentContext.transfer_with_liquid_class` method. For more details, including using the :py:meth:`.InstrumentContext.distribute_with_liquid_class` and :py:meth:`.InstrumentContext.consolidate_with_liquid_class` methods, see :ref:`v2-complex-commands`. | |||
There was a problem hiding this comment.
The full names here make the paragraph wrap in a way that's hard to read. Let's use the shortened versions.
Suggested change
| This section covers selecting a liquid class and using the :py:meth:`.InstrumentContext.transfer_with_liquid_class` method. For more details, including using the :py:meth:`.InstrumentContext.distribute_with_liquid_class` and :py:meth:`.InstrumentContext.consolidate_with_liquid_class` methods, see :ref:`v2-complex-commands`. | |
| This section covers selecting a liquid class and using the :py:meth:`~.InstrumentContext.transfer_with_liquid_class` method. For more details, including using the :py:meth:`~.InstrumentContext.distribute_with_liquid_class` and :py:meth:`~.InstrumentContext.consolidate_with_liquid_class` methods, see :ref:`v2-complex-commands`. |
api/docs/v2/robot_position.rst
Outdated
| @@ -62,7 +62,7 @@ This is a good position for :ref:`aspirating liquid <new-aspirate>` or an activi | |||
|
|
|||
| .. warning:: | |||
|
|
|||
| Negative ``z`` arguments to ``Well.bottom()`` will cause the pipette tip to collide with the bottom of the well. Collisions may bend the tip (affecting liquid handling) and the pipette may be higher than expected on the z-axis until it picks up another tip. | |||
| Negative ``z`` arguments to ``Well.bottom()`` will cause the pipette tip to collide with the bottom of the well. Collisions may bend the tip (affecting liquid handling) and the pipette may be higher than expected on the z-axis until it picks up another tip. Use caution when changing the `z` height, including pipetting at a liquid meniscus, especially in reservoir wells. | |||
There was a problem hiding this comment.
I'm inclined to leave this out, for a few reasons:
- The problem in EXEC-1637 isn't really new; it's the combination of an existing problem with meniscus-relative pipetting.
- This doesn't really state what the problem is, or a concrete way to mitigate it.
- This section is about
bottom(), notmeniscus().
If we have labware definitions that are causing crashes when moving to Well.bottom(z=1), that's a problem and we should call it out. But we can do that after the 8.5 launch.
…entrons into docs-callouts merge chore release 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
Small PR to add a few final docs callouts before the 8.5 release:
transfer_with_liquid_class(). @sanni-t pointed out that users might not know where to find this kind of detail.Test Plan and Hands on Testing
http://sandbox.docs.opentrons.com/docs-callouts/v2/
both small changes build with no issues
Changelog
Review requests
Is this sufficient for EXEC-1637? @caila-marashaj and I discussed keeping this simple, including leaving it at all reservoirs, for extra caution. fix for this should be in 8.6.
Risk assessment
low.