docs(api): more partial tip pickup docstrings #14132
Conversation
| *left-to-right* from a tip rack. Use ``"A12"`` to have the pipette use its | ||
| rightmost nozzles to pick up tips *right-to-left* from a tip rack. | ||
| :type start: str or ``None`` |
There was a problem hiding this comment.
This is the opposite actually.. the rightmost nozzle column picks up tips left-to-right from the tiprack. Or am I not understanding this sentence corectly?
There was a problem hiding this comment.
Yes, you're right, it's wrong. I keep having to make hand motions every time I need to figure this out 😆
| :param tip_racks: List of tip racks to use during this configuration. | ||
| :param tip_racks: Behaves the same as setting the ``tip_racks`` parameter of | ||
| :py:meth:`.load_instrument`. If not specified, | ||
| :py:obj:`.InstrumentContext.tip_racks` will be reset to ``None`` and you |
There was a problem hiding this comment.
tip_racks is reset to an empty list actually
| To keep the same list of tip racks when changing configurations, reference | ||
| the same instrument's existing ``tip_racks`` parameter:: | ||
|
|
||
| pipette.configure_nozzle_layout( | ||
| style=COLUMN, | ||
| tip_racks=pipette.tip_racks | ||
| ) |
There was a problem hiding this comment.
I feel like this would be better as part of the high level Opentrons docs than the API method docstrings because a) it's not critical info and b) it doesn't give you the full and probably more important details of why you actually shouldn't use the same tip racks when switching between the 96 channel's partial and full configurations.
There was a problem hiding this comment.
Actually, I just realized the note about 96 ch partial config tipracks already exists in this docstring. Then I'm cool keeping this here.
There was a problem hiding this comment.
Nah, I think you're right. Too clever by half for docstrings.
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## chore_release-7.1.0 #14132 +/- ##
====================================================
Coverage 70.44% 70.44%
====================================================
Files 2512 2512
Lines 71201 71201
Branches 8964 8964
====================================================
Hits 50161 50161
Misses 18849 18849
Partials 2191 2191
Flags with carried forward coverage won't be shown. Click here to find out more.
|
There was a problem hiding this comment.
Changes look good!
There's just one thing to be aware of- we currently only (fully) support setting the rightmost column of the 96 channel for partial config. If you set the A1 as primary nozzle then your pipette will move correctly but there's no deck conflict checking or auto tip tracking for it yet. But it won't raise any errors either. So maybe we should put a note in there that currently only A12 as primary nozzle is fully supported and the others are use it at your own risk.
Talked with @anthonywilleee and we decided this is too risky to recommend, even with warnings. Gonna push another change to reflect that. I made a note on RTC-365 to come back to the A1 configuration later. |
|
OK, I think this PR has finally settled into the same place we expect the feature to be at launch! |
Overview
Expand on the initial docstring for
configure_nozzle_layout(#13997) to include the new tip-tracking behavior (#14104).Test Plan
Check the entries in the sandbox.
Changelog
tip_rackparameter, with reference to same parameter ofload_instrument, based on conversation with @sanni-t.active_channelsproperty.Review requests
This is how it works, yeah?
Risk assessment
nil, docstrings.