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): updated versioning page and API reference for mix #16833

Open
wants to merge 2 commits into
base: edge
Choose a base branch
from

Conversation

emilyburghardt
Copy link
Collaborator

@emilyburghardt emilyburghardt commented Nov 14, 2024

Overview

Updating versioning page and API reference for changes to mix behavior

Test Plan and Hands on Testing

http://sandbox.docs.opentrons.com/docs-lld-mix/v2/

Changelog

4 lines in versioning.rst to provide description of changes to mix behavior in version 2.21
2 lines in instrument_context.py to provide description of changes to mix behavior in version 2.21

Review requests

no special requests

Risk assessment

low

@emilyburghardt emilyburghardt requested a review from a team as a code owner November 14, 2024 19:33
@emilyburghardt emilyburghardt added api Affects the `api` project docs labels Nov 14, 2024
Copy link
Contributor

@ecormany ecormany left a comment

Choose a reason for hiding this comment

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

Generally looks good! You could add one more commit to adjust the wording. Or merge as-is and I can make further edits when I pick up RTC-622.

@@ -134,6 +134,10 @@ This table lists the correspondence between Protocol API versions and robot soft
Changes in API Versions
=======================

Version 2.21
------------
- Only check for liquid presence detection on the first aspiration of the :py:meth:`.mix` cycle.
Copy link
Contributor

Choose a reason for hiding this comment

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

Oops, I think we kind of wrote ourselves into a knot here. We didn't mean "check for…detection". Flipping it works:

Suggested change
- Only check for liquid presence detection on the first aspiration of the :py:meth:`.mix` cycle.
- Liquid presence detection now only checks on the first aspiration of a :py:meth:`.mix` cycle.

Could additionally link Liquid presence detection to that section on the Loading Pipettes page, but may be overkill.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Affects the `api` project docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants