refactor(api): better names for liquid probe commands #15578
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Edit detect_liquid_presence, require_liquid_presence, and measure_liquid_height as per the standup today.
SyntaxColoring
requested changes
Jul 3, 2024
sfoster1
reviewed
Jul 3, 2024
There was a problem hiding this comment.
Before we merge, let's
- Change the subject line of the PR to be an indication of what the changes do, rather than what the changes are (for instance,
refactor(api): better names for liquid probe commands, orrefactor(api): handle errors in liquid probe commands) - Since the subject line is too small to have enough information, use the description to go into more depth, even if that depth is just a bullet list about changing names and handling errors
aaron-kulkarni
changed the title
SyntaxColoring
requested changes
Jul 5, 2024
There was a problem hiding this comment.
-
Here are a couple of test fixups.
-
Let's try to fill in the "test plan" and "risk assessment" sections of the PR description.
I think I overheard you and @ryanthecoder talk about writing some Python protocols to play around with it. That sounds like a good idea, and you can describe that as the test plan. Just make it clear whether you're going to do that before or after merging this.
Other than that, looks great.
P.S. Here is the bug that I'm predicting will be exposed by this, which I alluded to in the last PR. EXEC-598. (It's my fault, not yours. 🙂)
api/tests/opentrons/protocol_api/core/engine/test_instrument_core.py
Outdated
Show resolved
Hide resolved
SyntaxColoring
approved these changes
Jul 8, 2024
api/tests/opentrons/protocol_api/core/engine/test_instrument_core.py
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Edit detect_liquid_presence, require_liquid_presence, and measure_liquid_height as per the standup today.
Change instrument_context tests to check for the right error(LiquidNotFoundError)
Split find_liquid_level into two functions: liquid_probe_with_recovery and liquid_probe_without_recovery
Test Plan
Added unit tests for liquid_probe_with_recovery and liquid_probe_without recovery to test_instrument_core.py
Added unit tests for detect_liquid_presence, require_liquid_presence, and measure_liquid_height to test_instrument_context.py
After the PR is merged, these API calls will be tested on the robot.
Changelog
Review requests
Accidentally merged #15555 too soon, this is a continuation of that PR.
Risk assessment
Low: Since all the work was done in newly created functions, the risk that it breaks existing code is minimal.
However, the new API calls still do need to be tested on a robot before they can be used in other parts of the system.