docs(api): section on Position Relative to Trash Containers #14593

ecormany · 2024-03-04T19:18:36Z

Overview

Follow up to further explain behavior introduced in #14560.

Addresses RTC-400.

Test Plan

sandbox
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 locations
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.

codecov · 2024-03-04T19:23:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.50%. Comparing base (d6d9416) to head (6590f44).

Additional details and impacted files

@@                Coverage Diff                 @@
##           docs_release-2.18   #14593   +/-   ##
==================================================
  Coverage              67.50%   67.50%           
==================================================
  Files                   2514     2514           
  Lines                  72376    72376           
  Branches                9317     9317           
==================================================
  Hits                   48857    48857           
  Misses                 21314    21314           
  Partials                2205     2205

Flag	Coverage Δ
g-code-testing	`92.43% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
...i/src/opentrons/protocol_api/instrument_context.py	`89.09% <ø> (ø)`

api/docs/v2/robot_position.rst

api/src/opentrons/protocol_api/disposal_locations.py

ecormany · 2024-03-07T17:23:43Z

OK, after a near-miss rebasing this onto docs_release.2-18, this is ready for another review. Not much prose has changed (except some added in the API reference). Version added/changed notices have changed and moved around quite a bit — make sure I've tagged everything properly, especially related features added prior to 2.18.

jwwojak · 2024-03-07T18:28:19Z

api/docs/v2/robot_position.rst

+Position Relative to Trash Containers
+=====================================
+
+In API version 2.15 and earlier, trash containers are :py:class:`.Labware` objects that have a single well. Use the above techniques for labware to adjust position relative to trash containers in protocols specifying these API versions.


Word choice: "techniques" stands out as unusual to me. The content referred to are methods.

Might it make sense to write something like, "Use the labware methods above to adjust position relative to trash containers ..."

api/docs/v2/robot_position.rst

jwwojak

Added review comments for consideration. Defer to others re: go/no go approvals.

jbleon95 · 2024-03-07T21:58:05Z

api/src/opentrons/protocol_api/instrument_context.py


                            If only a ``location`` is passed (e.g.,
                            ``pipette.dispense(location=plate['A1'])``), all of the
                            liquid aspirated into the pipette will be dispensed (the
                            amount is accessible through :py:attr:`current_volume`).

+            .. versionchanged:: 2.18


This and the other methods in instrument context can accept TrashBin and WasteChute starting in version 2.16

I knew I had confused something. Thanks for checking!

jwwojak

Great revision.

…er methods (#14610) # Overview It's time for Python API version 2.18! Trash container `top()` methods are the first features included in this version-in-progress. # Test Plan - [sandbox](http://sandbox.docs.opentrons.com/papi-2.18-in-edge-time/v2/new_protocol_api.html#opentrons.protocol_api.TrashBin) - automated tests # Changelog - bump max supported version - decorate trash container top methods - hide those methods from API reference, for now. they will be _shown_ in #14593 and the 2.18 docs feature branch. # Review requests sensible? correct? well-timed? # Risk assessment v low. this version bump was coming sooner or later and shouldn't affect anything up through 2.17.

# 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.

…er methods (#14610) # Overview It's time for Python API version 2.18! Trash container `top()` methods are the first features included in this version-in-progress. # Test Plan - [sandbox](http://sandbox.docs.opentrons.com/papi-2.18-in-edge-time/v2/new_protocol_api.html#opentrons.protocol_api.TrashBin) - automated tests # Changelog - bump max supported version - decorate trash container top methods - hide those methods from API reference, for now. they will be _shown_ in #14593 and the 2.18 docs feature branch. # Review requests sensible? correct? well-timed? # Risk assessment v low. this version bump was coming sooner or later and shouldn't affect anything up through 2.17.

ecormany requested a review from a team as a code owner March 4, 2024 19:18

ecormany requested review from jwwojak, jbleon95 and a team and removed request for a team March 4, 2024 19:18

jwwojak reviewed Mar 4, 2024

View reviewed changes

api/docs/v2/robot_position.rst Outdated Show resolved Hide resolved

jbleon95 requested changes Mar 5, 2024

View reviewed changes

api/docs/v2/robot_position.rst Outdated Show resolved Hide resolved

api/src/opentrons/protocol_api/disposal_locations.py Outdated Show resolved Hide resolved

version 2.18

45e54bd

ecormany force-pushed the docs-trash-offsets branch from 365f7da to 45e54bd Compare March 7, 2024 15:34

ecormany added 6 commits March 7, 2024 10:45

fix typo+environs

6d9c62f

reframe .top() return type

f36a95c

versionchanged for location params

f8980c0

move versionchanged from methods to params

e15a920

expand dispense location docstring

2308641

2.18 in robot_position

8c4e580

ecormany changed the base branch from edge to docs_release-2.18 March 7, 2024 17:22

ecormany requested review from jwwojak and jbleon95 March 7, 2024 17:22

jwwojak reviewed Mar 7, 2024

View reviewed changes

api/docs/v2/robot_position.rst Show resolved Hide resolved

jwwojak reviewed Mar 7, 2024

View reviewed changes

jbleon95 reviewed Mar 7, 2024

View reviewed changes

jbleon95 approved these changes Mar 7, 2024

View reviewed changes

jbleon95 self-requested a review March 7, 2024 21:58

ecormany added 2 commits March 7, 2024 17:17

reorder § on position, remove outdated note on deck slots

1bc1e2e

oops, 2.16 in instrument_context

6590f44

ecormany requested a review from jwwojak March 7, 2024 22:36

jwwojak approved these changes Mar 8, 2024

View reviewed changes

ecormany mentioned this pull request Mar 8, 2024

chore(api): bump Python API version to 2.18 and tag new trash container methods #14610

Merged

ecormany merged commit 2630fb9 into docs_release-2.18 Mar 8, 2024
22 checks passed

ecormany deleted the docs-trash-offsets branch October 16, 2024 20:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(api): section on Position Relative to Trash Containers #14593

docs(api): section on Position Relative to Trash Containers #14593

ecormany commented Mar 4, 2024 •

edited

Loading

codecov bot commented Mar 4, 2024 •

edited

Loading

ecormany commented Mar 7, 2024

jwwojak Mar 7, 2024

jwwojak left a comment

jbleon95 Mar 7, 2024

ecormany Mar 7, 2024

jwwojak left a comment

docs(api): section on Position Relative to Trash Containers #14593

docs(api): section on Position Relative to Trash Containers #14593

Conversation

ecormany commented Mar 4, 2024 • edited Loading

Overview

Test Plan

Changelog

Review requests

Risk assessment

codecov bot commented Mar 4, 2024 • edited Loading

Codecov Report

ecormany commented Mar 7, 2024

jwwojak Mar 7, 2024

Choose a reason for hiding this comment

jwwojak left a comment

Choose a reason for hiding this comment

jbleon95 Mar 7, 2024

Choose a reason for hiding this comment

ecormany Mar 7, 2024

Choose a reason for hiding this comment

jwwojak left a comment

Choose a reason for hiding this comment

ecormany commented Mar 4, 2024 •

edited

Loading

codecov bot commented Mar 4, 2024 •

edited

Loading