docs(api): refactor Pipettes page to include partial tip pickup #14189
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## edge #14189 +/- ##
==========================================
- Coverage 70.41% 70.40% -0.02%
==========================================
Files 2513 2513
Lines 71323 71306 -17
Branches 9033 9033
==========================================
- Hits 50223 50201 -22
- Misses 18894 18899 +5
Partials 2206 2206
Flags with carried forward coverage won't be shown. Click here to find out more. |
ecormany
force-pushed
the
docs-refactor-pipettes-partial-pickup
branch
from
4b13c75 to
07a3c93
Compare
api/docs/v2/pipettes/configuring.rst
Outdated
| tip_rack = protocol.load_labware("opentrons_flex_96_tiprack_1000ul", "C1") | ||
| pipette.configure_nozzle_layout(style=COLUMN, start="A1") | ||
| row_a = tiprack.rows()[0] | ||
| pipette.pick_up_tip(row_a.pop()) # pick up A12-H12 | ||
| pipette.drop_tip() | ||
| pipette.pick_up_tip(row_a.pop()) # pick up A11-H11 | ||
| pipette.drop_tip() |
Co-authored-by: Sanniti Pimpley <[email protected]>
| Pipettes | ||
| ######## | ||
| ******** | ||
|
|
There was a problem hiding this comment.
Super nice. Breaking up a very long doc into individual sections. Partial tip is significant enough to warrant it's own standalone subsection under the Pipettes heading.
|
|
||
| .. _new-pipette-models: | ||
|
|
||
| API Load Names |
There was a problem hiding this comment.
Nice move. This puts the load names up front. 👏
|
|
||
| .. _pipette-tip-racks: | ||
|
|
||
| Adding Tip Racks |
There was a problem hiding this comment.
This is a change too, moving under Loading Pipettes. 👏
| Nozzle Layout | ||
| ============= | ||
|
|
||
| Use the :py:meth:`.configure_nozzle_layout` method to choose how many tips the 96-channel pipette will pick up. The method's ``style`` parameter accepts special layout constants. You must import these constants at the top of your protocol, or you won't be able to configure the pipette for partial tip pickup. |
There was a problem hiding this comment.
One comment here and it refers to the COLUMN argument definition for configure_nozzle_layout, not the text on this page. I meant to include it yesterday, but it was buried in my notes and overlooked. This part of the method definition, on first read, is confusing:
sets the pipette to use 8 nozzles, aligned from front to back with respect to the deck. This corresponds to a column of wells on labware.
My first reaction to "aligned from front to back with respect to the deck" was a big ❓ Pipette barrels or channels don't have their own coordinates so it might help with clarity to use well coordinates in that last sentence to clarify. For example:
This corresponds to a column of wells on labware (e.g. A1-H1, A2-H2, A3-H3, etc.).
Maybe I'm just dumb, but I had to read the argument definition a few times before coming to what I hoped is an understanding of what it means.
There was a problem hiding this comment.
Yeah, that was a tough definition to write. "It's a column, you know, like a column!"
Going to leave it for now, because that text will be revised as soon as additional layouts are added.
| Finally, we configure the nozzle layout, with three arguments. | ||
|
|
||
| - The ``style`` parameter directly accepts the ``COLUMN`` constant, since we imported it at the top of the protocol. | ||
| - The ``start`` parameter accepts a nozzle name, representing the back-left nozzle in the layout, as a string. ``"A12"`` tells the pipette to use its rightmost column of nozzles for pipetting. | ||
| - The ``tip_racks`` parameter tells the pipette which racks to use for tip tracking, just like :ref:`adding tip racks <pipette-tip-racks>` when loading a pipette. |
There was a problem hiding this comment.
Great use of bullets here. 🥇
ecormany
changed the title
Overview
Complete refactor of the single Pipettes page into multiple pages. It was already approaching 4000 words, and explaining partial tip pickup will take another ~1500.
Test Plan
opentrons_simulaterunning fromv7.1.0tag. protocol fileChangelog
new_pipette.rstinto a landing page.Review requests
Prose: @jwwojak
Code: @sanni-t
pop()for ad hoc tip tracking?Risk assessment
No code risk. Big refactor for docs.