docs(api): corrections to docstrings involving TrashBins
#14194
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
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## chore_release-7.1.0 #14194 +/- ##
====================================================
Coverage 70.45% 70.45%
====================================================
Files 2512 2512
Lines 71237 71237
Branches 8982 8982
====================================================
Hits 50189 50189
Misses 18849 18849
Partials 2199 2199
Flags with carried forward coverage won't be shown. Click here to find out more.
|
SyntaxColoring
approved these changes
Dec 13, 2023
Comment on lines
1055
to
1064
| """The trash fixed to slot 12 of an OT-2's deck. | ||
|
|
||
| In API Versions prior to 2.16 it has one well and should be accessed like labware in your protocol. | ||
| e.g. ``protocol.fixed_trash['A1']`` | ||
| In API version 2.15 and earlier, the fixed trash is a :py:class:`.Labware` object with one well. Access it like labware in your protocol. For example, ``protocol.fixed_trash['A1']``. | ||
|
|
||
| In API Version 2.16 and above it returns a Trash fixture for OT-2 Protocols. | ||
| In API version 2.15 only, Flex protocols have a fixed trash in slot A3. | ||
|
|
||
| In API version 2.16 and later, the fixed trash only exists in OT-2 protocols. It is a :py:class:`.TrashBin` object, which doesn't have any wells. Trying to access ``fixed_trash`` in a Flex protocol will raise an error. | ||
|
|
||
| .. versionchanged:: 2.16 | ||
| Returns a :py:class:`.TrashBin` object. |
There was a problem hiding this comment.
This looks good to me, but:
- See https://github.com/Opentrons/opentrons/pull/14193/files if any of my alternative phrasing over there is helpful.
- I would consider squeezing in a reference to
:ref:`configure-trash-bin`.
jwwojak
reviewed
Dec 14, 2023
Co-authored-by: Max Marrone <[email protected]>
ncdiehl11
pushed a commit
that referenced
this pull request
Dec 20, 2023
--------- Co-authored-by: Max Marrone <[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
Updates the docstrings for
fixed_trashandtrash_containerto accurately reflect how they work with different robot types and API versions.Test Plan
Check API reference entries.
fixed_trashtrash_containerChangelog
drop_tip()doesn't go to the "default"trash_container— it goes to the current value.Review requests
I love it because it's trash?
Risk assessment
v low, docstrings only