Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(api): update descriptions of partial tip pickup behavior for 7.3 #15003

Merged
merged 2 commits into from
Apr 29, 2024

Conversation

ecormany
Copy link
Contributor

@ecormany ecormany commented Apr 24, 2024

Overview

Update partial tip pickup docs to reflect the latest behavior, as added in #15009 and to be released in robot software 7.3.

Addresses RTC-440.

Test Plan

Sandbox

Changelog

  • Removed "Column 12" and "Column 1" headers from Partial Tip Pickup page. Removed tip-tracking code for Column 1 as no longer needed..
  • Reworded note in configure_nozzle_layout API reference entry.

Review requests

Already spoke with @CaseyBatten to get an idea of what needed to be included here and what will go in separate documentation.

  • Should we actually put this straight into edge and deploy ASAP, or can it wait a month and roll out with 2.18 docs (current plan)? PAPI 2.18 deploy will be timed with robot stack 7.3 release, which this aligns with.

Risk assessment

none

@ecormany ecormany added docs papi-v2 Python API V2 labels Apr 24, 2024
@ecormany ecormany requested a review from a team as a code owner April 24, 2024 20:22
Copy link
Contributor

@CaseyBatten CaseyBatten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good so far, but some feedback on inaccuracies below.

api/docs/v2/pipettes/partial_tip_pickup.rst Outdated Show resolved Hide resolved
api/docs/v2/pipettes/partial_tip_pickup.rst Outdated Show resolved Hide resolved
@ecormany ecormany marked this pull request as draft April 24, 2024 20:36
Copy link
Contributor

@CaseyBatten CaseyBatten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes look great and remove any ambiguity we had during the transition from 7.1 to 7.2.

@@ -106,6 +106,10 @@ When switching between full and partial pickup, you may want to organize your ti
partial_tip_racks = [tips_1, tips_2]
full_tip_racks = [tips_3, tips_4]

.. Tip::

It's also good practice to keep separate lists of tip racks when using multiple partial tip pickup configurations (i.e., using both column 1 and column 12 in the same protocol). This improves positional accuracy when picking up tips. Additionally, use Labware Position Check in the Opentrons App to ensure that the partial configuration is well-aligned to the rack.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good and communicates what we want. Regarding the last sentence, I think we need to confirm what exactly LPC looks like for partial configuration (I personally have never encountered it) and communicate that if possible.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just spoke with Sanniti, looks like LPC for partial tips is just standard LPC. You'd account for the tip overlap offset during said LPC, then presumably only use the partial configuration you LPC'd for on that piece of labware. So I think this documentation is acceptable on that front, we don't want to over-explain and end up causing confusion once this problem is addressed in full.

@ecormany ecormany marked this pull request as ready for review April 29, 2024 14:58
@ecormany ecormany changed the title docs(api): discourage column 1 partial tip pickup docs(api): update descriptions of partial tip pickup behavior for 7.3 Apr 29, 2024
@ecormany ecormany merged commit f3fafd3 into docs_release-2.18 Apr 29, 2024
20 checks passed
ecormany added a commit that referenced this pull request May 2, 2024
…#15003)

Update partial tip pickup docs to reflect the latest behavior, as added
in #15009 and to be released in robot software 7.3.

Addresses RTC-440.

[Sandbox](http://sandbox.docs.opentrons.com/docs-partial-pickup-channel-1/v2/)

- Removed "Column 12" and "Column 1" headers from Partial Tip Pickup
page. Removed tip-tracking code for Column 1 as no longer needed..
- Reworded note in `configure_nozzle_layout` API reference entry.

Already spoke with @CaseyBatten to get an idea of what needed to be
included here and what will go in separate documentation.

- <s>Should we actually put this straight into `edge` and deploy ASAP,
or can it wait a month and roll out with 2.18 docs (current plan)?</s>
PAPI 2.18 deploy will be timed with robot stack 7.3 release, which this
aligns with.

none
@ecormany ecormany deleted the docs-partial-pickup-channel-1 branch October 16, 2024 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs papi-v2 Python API V2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants