docs(api): liquid presence verification (#15695) #16033
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
# Overview Adding new documentation to describe new Liquid Presence Verification methods, includes updating docstrings. Sandbox links below. The JIRA ticket is [RTC-148](https://opentrons.atlassian.net/browse/RTC-148). # Test Plan Review the new docs. # Changelog **New** Adds a new H2 section, [Liquid Presence Verification](http://sandbox.docs.opentrons.com/docs-liquid-presence-detection/v2/pipettes/loading.html#liquid-presence-verification) to the page, Loading Pipettes (`loading.rst`). Includes two H3 subsections: - [Enable LPV Globally](http://sandbox.docs.opentrons.com/docs-liquid-presence-detection/v2/pipettes/loading.html#enable-lpv-globally) - [Turning LPV Off and On](http://sandbox.docs.opentrons.com/docs-liquid-presence-detection/v2/pipettes/loading.html#turing-lpv-off-and-on) **New** Adds two new H2 sections to the page, Liquid Control (`liquids.rst`): - [Detect Liquids](http://sandbox.docs.opentrons.com/docs-liquid-presence-detection/v2/basic_commands/liquids.html#detect-liquids) - [Require Liquids](http://sandbox.docs.opentrons.com/docs-liquid-presence-detection/v2/basic_commands/liquids.html#require-liquids) **Revisions/Additions** Small changes to docstrings for: - `liquid_presence_detection`, an argument of [load_instrument](http://sandbox.docs.opentrons.com/docs-liquid-presence-detection/v2/new_protocol_api.html?highlight=load_instrument#opentrons.protocol_api.ProtocolContext.load_instrument) - [detect_liquid_presence](http://sandbox.docs.opentrons.com/docs-liquid-presence-detection/v2/new_protocol_api.html?highlight=detect_liquid_presence) in v2 Reference. - [require_liquid_presence](http://sandbox.docs.opentrons.com/docs-liquid-presence-detection/v2/new_protocol_api.html?highlight=require_liquid_presence) # Review requests Take a look and or before adding others. # Risk assessment Low. Docs changes only. [RTC-148]: https://opentrons.atlassian.net/browse/RTC-148?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Edward Cormany <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## chore_release-8.0.0 #16033 +/- ##
======================================================
Coverage ? 63.17%
======================================================
Files ? 288
Lines ? 15279
Branches ? 0
======================================================
Hits ? 9652
Misses ? 5627
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. |
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.
Cherry Pick the LLD docs