docs(api): Python Protocol API 2.18 #14611
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
ecormany
added
docs
DO NOT MERGE
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## edge #14611 +/- ##
==========================================
- Coverage 67.50% 67.20% -0.31%
==========================================
Files 2521 2495 -26
Lines 72090 71406 -684
Branches 9311 8992 -319
==========================================
- Hits 48666 47985 -681
- Misses 21228 21305 +77
+ Partials 2196 2116 -80
Flags with carried forward coverage won't be shown. Click here to find out more.
|
ecormany
force-pushed
the
docs_release-2.18
branch
from
2630fb9 to
4eb3384
Compare
ecormany
changed the title
ecormany
force-pushed
the
docs_release-2.18
branch
from
215846e to
c00a37f
Compare
ecormany
force-pushed
the
docs_release-2.18
branch
from
c00a37f to
b6f5201
Compare
# Overview Follow up to further explain behavior introduced in #14560. Addresses RTC-400. # Test Plan - [sandbox](http://sandbox.docs.opentrons.com/docs-trash-offsets/v2/robot_position.html#position-relative-to-trash-containers) - simulated snippets in 2.16 / `edge` # Changelog - new § on Labware and Deck Positions page - updated description and example for `move_to()` to cover new acceptable `location`s - version added statements for `TrashBin`, `WasteChute`, and their methods in API Reference # Review requests - double check code snippets. not only simulate, but do what i say they do? - confirm version added for the methods. it feels like we may need to gate this to 2.17, because otherwise there will be a big functionality gap between robot system 7.1 (which can't do any of this) and 7.2 (which can). the classes are unambiguously _New in version 2.16._ # Risk assessment low…but see API version gate caveat above.
…#15003) Update partial tip pickup docs to reflect the latest behavior, as added in #15009 and to be released in robot software 7.3. Addresses RTC-440. [Sandbox](http://sandbox.docs.opentrons.com/docs-partial-pickup-channel-1/v2/) - Removed "Column 12" and "Column 1" headers from Partial Tip Pickup page. Removed tip-tracking code for Column 1 as no longer needed.. - Reworded note in `configure_nozzle_layout` API reference entry. Already spoke with @CaseyBatten to get an idea of what needed to be included here and what will go in separate documentation. - <s>Should we actually put this straight into `edge` and deploy ASAP, or can it wait a month and roll out with 2.18 docs (current plan)?</s> PAPI 2.18 deploy will be timed with robot stack 7.3 release, which this aligns with. none
# Overview Documents [updated behavior](#14940) for `Labware.set_offset()` in Python API version 2.18. Addresses RTC-234 # Test Plan Sandbox: - [API reference entry](http://sandbox.docs.opentrons.com/docs-set_offset-updates/v2/new_protocol_api.html#opentrons.protocol_api.Labware.set_offset) - [new section](http://sandbox.docs.opentrons.com/docs-set_offset-updates/v2/new_advanced_running.html#labware-offset-behavior) of Advanced Control # Changelog - adapted new docstring draft written by @sfoster1 - adapt sample code and move it to Advanced Control # Review requests have we accurately captured the three phases of behavior (2.12–13, 14–17, 18+)? # Risk assessment none
ecormany
force-pushed
the
docs_release-2.18
branch
from
cdecc11 to
a55d47a
Compare
…#15078) # Overview Describe the new `apiLevel`-gated behavior for `drop_tip()` in Python API 2.18. Addresses RTC-448 # Test Plan [Sandbox API ref entry](http://sandbox.docs.opentrons.com/docstring-drop-tip-alternating-2.18/v2/new_protocol_api.html#opentrons.protocol_api.InstrumentContext.drop_tip) # Changelog Move ¶ about change in 2.15 down, and add another ¶ about 2.18. # Review requests This is how it works, right? # Risk assessment None, docstring only.
# Overview Full documentation for setting up and using runtime parameters in Python protocols. Closes RTC-416, RTC-428, RTC-429, RTC-430, RTC-451 # Test Plan - Check content and formatting of all pages in the [sandbox](http://sandbox.docs.opentrons.com/docs-rtp/v2/runtime_parameters.html) - Simulate all [code from use case pages](https://gist.github.com/ecormany/9f4d871851ec4baceb9fae177663dd00). # Changelog - New landing page for Runtime Parameters - 6 new subpages - Unhide `ProtocolContext.params` in API Reference. ~Note, this still needs a docstring, either here or in a separate PR.~ Added [docstring](http://sandbox.docs.opentrons.com/docs-rtp/v2/new_protocol_api.html#opentrons.protocol_api.ProtocolContext.params). # Review requests Read some or all of it, try the code, tell me what can be better. # Risk assessment None --------- Co-authored-by: Sanniti Pimpley <[email protected]>
# Overview Summarize all of the changes in Python API 2.18 on the Versioning documentation page. Closes RTC-463 # Test Plan [Sandbox](http://sandbox.docs.opentrons.com/docs-versioning-2.18/v2/versioning.html) # Changelog - add row to version table - feature bullets # Review requests any glaring omissions? # Risk assessment nil
…ng reanalysis (#15195) # Overview Testing revealed that labware offsets aren't applied to labware that are only loaded as the result of custom RTP values. This is somewhat expected, due to the order of operations: analyze -> apply offsets -> choose RTP values -> reanalyze. This docs addition goes into much greater detail than the very short summary we could fit into the release notes (see #15194). # Test Plan [Sandbox](http://sandbox.docs.opentrons.com/docs-rtp-plate-swap/v2/parameters/using_values.html#limitations) # Review requests Is this too much? Will it all be rendered moot by a hotfix? # Risk assessment none
ecormany
removed
the
DO NOT MERGE
jbleon95
approved these changes
May 23, 2024
# Overview I got the type specification for the object of `add_parameters()` wrong. # Test Plan Simulated a protocol that uses the `def add_parameters(…` line verbatim on 7.3.0-b1. # Changelog 1-line diff # Risk assessment none
# Overview This is a manual process now! Didn't forget this time. `|apiLevel|` will now be replaced with `2.18`. # Test Plan [Sandbox](http://sandbox.docs.opentrons.com/docs-bump-version-218/v2/versioning.html#maximum-supported-versions) <- mostly observe the text replacement in the max supported version ranges. # Changelog - new API version - new robot software version! # Risk assessment nil
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
This is the feature branch for Python API version 2.18 docs.
Please base all PRs with 2.18-related docs here, rather than on
edge, if possible. (But get code into whatever branch makes sense.)