docs(api): liquid presence verification #15695
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
Make it clear this is for Flex only and include the version.
Deve environment conked out.
Forgot ~.
This is the bulk or main part of LLD. The smaller methods, detect_liquid_presence and require_liquid_presence, are not here or in this draft. Those will go in the building block commands doc.
Fixing because it raises warnings during docs builds.
Name changes and stubs.
|
Didn't check w/ Black before opening PR. |
Changes to descriptions in Building Block Commands and in the docstring references.
ecormany
changed the title
Changes from Ed's recommendations (Slack) and change name to "Liquid Presence Detection" from "Liquid Presence Verification." Some outstanding issues: code sample. Will get help w/ this.
This is the bulk or main part of LLD. The smaller methods, detect_liquid_presence and require_liquid_presence, are not here or in this draft. Those will go in the building block commands doc.
Fixing because it raises warnings during docs builds.
Name changes and stubs.
Changes to descriptions in Building Block Commands and in the docstring references.
Changes from Ed's recommendations (Slack) and change name to "Liquid Presence Detection" from "Liquid Presence Verification." Some outstanding issues: code sample. Will get help w/ this.
I'm a bit burned out. Saving to save.
ecormany
force-pushed
the
docs-liquid-presence-detection
branch
from
c6a6fde to
36aea23
Compare
…pentrons/opentrons into docs-liquid-presence-detection
ecormany
requested changes
Aug 1, 2024
There was a problem hiding this comment.
Some changes to make. Semantic changes are around being clear about exactly when LLD happens, the difference between detecting and requiring, and the strong link between the require standalone method and global detection (naming things is hard, so it goes). Syntactic changes are to get the big code block working — get engineer support as needed. And stylistic changes are all to be blamed on the Pythonistas 🐍 🧐
api/docs/v2/pipettes/loading.rst
Outdated
| Enable Liquid Presence Detection | ||
| -------------------------------- | ||
|
|
||
| The easiest, and recommended, way to use Liquid Presence Detection is by adding the optional Boolean argument, ``liquid_presence_detection=True`` to :py:meth:`.ProtocolContext.load_instrument` in your protocol. When ``True``, the robot will check for liquid on every aspiration. You can also turn this feature off and back on again later in a protocol. This example adds Liquid Presence Detection to the 8-Channel Pipette used in the sample protocol at the top of the page. |
There was a problem hiding this comment.
- Not recommended, because of how time-consuming it is.
- Remove comma after "argument" since the monospace formatting does the work (and this isn't an appositive).
- Last sentence, probably better to say "enables…for" instead of "adds…to"
| @@ -2120,7 +2120,7 @@ def configure_nozzle_layout( # noqa: C901 | |||
|
|
|||
| @requires_version(2, 20) | |||
| def detect_liquid_presence(self, well: labware.Well) -> bool: | |||
| """Check if there is liquid in a well. | |||
| """Checks if there is liquid in a well. Will not raise an error if it does not detect liquid. Flex pipettes only. See :ref:`lpd` and :ref:`detect-liquid-presence`. | |||
|
|
|||
| :returns: A boolean. | |||
There was a problem hiding this comment.
We could remove line 2125, or move the prose description of the values of true and false here.
There was a problem hiding this comment.
Will move the longer, prose description to :returns: (line 2125).
Committing recommended changes. Will continue to work on others. Co-authored-by: Ed Cormany <[email protected]>
Made changes based on Ed's comments and our meeting today. Got many, but not all. More to come.
-- removed code sample -- added text about pressure sensor locations -- ready for review again
ecormany
approved these changes
Aug 16, 2024
y3rsh
pushed a commit
that referenced
this pull request
Aug 16, 2024
# 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]>
y3rsh
added a commit
that referenced
this pull request
Aug 20, 2024
# Cherry Pick the LLD docs Co-authored-by: Joe Wojak <[email protected]> Co-authored-by: Edward Cormany <[email protected]>
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
Adding new documentation to describe new Liquid Presence Verification methods, includes updating docstrings. Sandbox links below.
The JIRA ticket is RTC-148.
Test Plan
Review the new docs.
Changelog
New
Adds a new H2 section, Liquid Presence Verification to the page, Loading Pipettes (
loading.rst). Includes two H3 subsections:New
Adds two new H2 sections to the page, Liquid Control (
liquids.rst):Revisions/Additions
Small changes to docstrings for:
liquid_presence_detection, an argument of load_instrumentReview requests
Take a look and or before adding others.
Risk assessment
Low. Docs changes only.