docs(api): additional partial tip pickup layouts in 2.20 #15778
Merged
Conversation
This file contains 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
ecormany
force-pushed
the
docs-more-partial-pickup
branch
from
ce8949a to
7dbb338
Compare
jwwojak
approved these changes
Aug 7, 2024
| @@ -21,7 +21,7 @@ Multi-Channel Movement | |||
|
|
|||
| All :ref:`building block <v2-atomic-commands>` and :ref:`complex commands <v2-complex-commands>` work with single- and multi-channel pipettes. | |||
|
|
|||
| To keep the protocol API consistent when using single- and multi-channel pipettes, commands treat the back left channel of a multi-channel pipette as its *primary channel*. Location arguments of pipetting commands use the primary channel. The :py:meth:`.InstrumentContext.configure_nozzle_layout` method can change the pipette's primary channel, using its ``start`` parameter. See :ref:`partial-tip-pickup` for more information. | |||
| To keep the protocol API consistent when using single- and multi-channel pipettes, location arguments of pipetting commands use the pipette's *primary channel*. For multi-channel pipettes picking up tips with all of their channels, the back-left channel is considered primary. When using fewer channels, the ``start`` parameter of the :py:meth:`.InstrumentContext.configure_nozzle_layout` method can change the pipette's primary channel. See :ref:`partial-tip-pickup` for more information. | |||
There was a problem hiding this comment.
Suggest striking "considered" from this sentence:
"For multi-channel pipettes picking up tips with all of their channels, the back-left channel is considered primary."
Or even write it as, "...the back-left channel is the primary channel."
There was a problem hiding this comment.
Being subtle here. The choice of primary nozzle in ALL configuration is implicit and can be overridden, although I'm pretty sure this is a bad idea:
8ch_pipette.configure_nozzle_layout(
style=ALL,
start="H1",
)
Comment on lines
+137
to
+139
| Consider the placement of your tip rack when choosing the ``start`` value for row pickup. The pipette cannot pick up from back to front (``start="H1"``) on tip racks in row A of the deck, nor can it pick up from front to back (``start="A1"``) on tip racks in row D of the deck. This is because the pipette can't move far enough backward or forward, respectively, to align over those tips. | ||
|
|
||
| Use a different ``start`` value, or load the tip rack in row B or C. |
There was a problem hiding this comment.
Probably not possible in a note:: in rst. This seems like an ideal case for bullets to emphasize the thing to avoid/not to do:
The pipette cannot pick up from:
- Back to front (
start="H1") on tip racks in row A of the deck. - Front to back (
start="A1") on tip racks in row D of the deck.
...
Also, recommend putting emphasis on cannot in the note text.
y3rsh
reviewed
Aug 7, 2024
|
OK, merging this monster. If anything is amiss, I can do a follow-up. |
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
Document the new
ROW,SINGLE, andPARTIAL_COLUMNconfigurations for partial tip pickup.Test Plan
Changelog
Review requests
Risk assessment
v low