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.

Sign up for GitHub

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

Jump to bottom

docs(api): load liquids in API 2.23 #18025

Open
wants to merge 3 commits into
base: chore_release-8.4.0
Choose a base branch
from
Open

docs(api): load liquids in API 2.23 #18025

wants to merge 3 commits into from

Conversation

emilyburghardt
Copy link
Collaborator

Overview

documenting a new method for loading liquids into labware in API 2.23.

Test Plan and Hands on Testing

sandbox: http://sandbox.docs.opentrons.com/docs-load-liquid/v2/

Changelog

  • updated "labeling liquids in wells" to "labeling liquids in labware"; changed examples in this section to use our new methods: Labware.load_liquid and Labware.load_liquid_by_well, and a mention for Labware.load_empty.
  • updated the API reference entries for the methods above, + added a deprecated message for the original load_liquid.

Review requests

  • code blocks correct? especially wells in each example...
  • anything I'm missing?
  • I edited the original API reference entries to remove the examples (used to write the examples in Labeling Liquids in Labware). Do we want them back?

Risk assessment

@emilyburghardt emilyburghardt requested a review from a team as a code owner April 9, 2025 23:16
emilyburghardt
emilyburghardt commented Apr 9, 2025
View reviewed changes
api/src/opentrons/protocol_api/labware.py Outdated

:param volume: The volume of liquid to load into each well, in 10µL.
:param volume: The volume of liquid to load into each well. Must be a multiple of 10.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Making an assumption here that this meant the volume must be a multiple of 10... but I could be wrong.

Copy link
Member

Choose a reason for hiding this comment

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

No thats definitely just a typo. Should be a multiple of 1.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thank you!!

@ecormany ecormany added docs papi-v2 Python API V2 labels Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sfoster1 sfoster1 sfoster1 left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
docs papi-v2 Python API V2
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@emilyburghardt @sfoster1 @ecormany